logo

utils-std

Collection of commonly available Unix tools git clone https://anongit.hacktivis.me/git/utils-std.git/

chmod.1 (3248B)

    

  1. .\" utils-std: Collection of commonly available Unix tools
  2. .\" Copyright 2017 Haelwenn (lanodan) Monnier <contact+utils@hacktivis.me>
  3. .\" SPDX-License-Identifier: MPL-2.0
  4. .Dd 2024-03-12
  5. .Dt CHMOD 1
  6. .Os
  7. .Sh NAME
  8. .Nm chmod
  9. .Nd Change files modes
  10. .Sh SYNOPSIS
  11. .Nm
  12. .Op Fl cRv
  13. .Ar mode
  14. .Ar file...
  15. .Nm
  16. .Op Fl cRv
  17. .Fl F Ar ref_file
  18. .Ar file...
  19. .Sh DESCRIPTION
  20. .Nm
  21. sets the permissions bits given by
  22. .Ar mode
  23. or copying permissions from
  24. .Ar ref_file
  25. on each given
  26. .Ar file ,
  27. .Pp
  28. .Ar mode
  29. can be either an octal natural number between 0 and 7777, or a symbolic operation like
  30. .Ql +r
  31. or
  32. .Ql g=o-x .
  33. See the
  34. .Sx OCTAL MODE
  35. and
  36. .Sx SYMBOLIC OPERATIONS
  37. sections for details.
  38. .Pp
  39. If
  40. .Ar mode
  41. starts with a dash (or is user-provided), it should be broken from options with a preceding double-dash
  42. .Pq --
  43. like so:
  44. .Dl chmod -v -- -w,+r foobar
  45. .Sh OPTIONS
  46. .Bl -tag -width Ds
  47. .It Fl c
  48. Print mode changes
  49. .It Fl F Ar ref_file
  50. Copy permission bits from
  51. .Ar ref_file
  52. into each
  53. .Ar file .
  54. .It Fl R
  55. Recurse into directories passed to
  56. .It Fl v
  57. Verbose, print both changes and retained modes
  58. .Ar file
  59. .El
  60. .Sh OCTAL MODE
  61. Octal natural number between 0 and 7777, which can be obtained by or'ing the following values:
  62. .br
  63. .Bl -tag -width 0000 -compact
  64. .It 4000
  65. setuid
  66. .It 2000
  67. setgid
  68. .It 1000
  69. sticky bit
  70. .It 0400
  71. user read
  72. .It 0200
  73. user write
  74. .It 0100
  75. user execute/search
  76. .It 0070
  77. group read, write, execute/search
  78. .It 0007
  79. others read, write, execute/search
  80. .El
  81. .Sh SYMBOLIC OPERATIONS
  82. Uses the following grammar:
  83. .Bd -literal
  84. mode   ::= clause [',' clause]*
  85. clause ::= who* action+
  86. action ::= [op | op perm+ | op permcopy]
  88. who  ::= 'u' | 'g' | 'o' | 'a'
  89. op   ::= '+' | '-' | '='
  90. perm ::= 'r' | 'w' | 'x' | 'X' | 's' | 't'
  92. permcopy ::= 'u' | 'g' | 'o'
  93. .Ed
  94. .Pp
  95. Which corresponds to:
  96. .Bl -tag -width permcopy
  97. .It mode
  98. List of
  99. .Ql clause
  100. to apply, each separated by a comma.
  101. .Pp
  102. For example
  103. .Ql g+r,o=g
  104. sets read permission for group part and copies to other part the resulting permissions of the group part.
  105. .It clause
  106. Optionally starts with
  107. .Ql who
  108. and contains one or more
  109. .Ql action .
  110. .Pp
  111. When
  112. .Ql who
  113. isn't given,
  114. .Xr umask 3
  115. is followed similarly to file creation.
  116. .It action
  117. Always starts with
  118. .Ql op ,
  119. optionally followed by either one or more
  120. .Ql perm ,
  121. or a single
  122. .Ql permcopy
  123. .It who
  124. user(u), group(g), other(o), all(a)
  125. .It op
  126. Operation to apply: add(+), del(-), set(=)
  127. .Pp
  128. When neither
  129. .Ql perm
  130. nor
  131. .Ql permcopy
  132. were given, set(=) clears all permissions.
  133. .It perm
  134. which permissions to assign:
  135. .Bl -tag -width X -compact
  136. .It r
  137. Read
  138. .It w
  139. Write
  140. .It x
  141. Execute/Search
  142. .It X
  143. Search (directories-only)
  144. .It s
  145. Setuid when assigned to user, setgid when assigned to group
  146. .It t
  147. Sticky bit
  148. .El
  149. .It permcopy
  150. who to copy permissions from: user(u), group(g), other(o)
  151. .El
  152. .Sh EXIT STATUS
  153. .Ex -std
  154. .Sh SEE ALSO
  155. .Xr stat 1
  156. .Sh STANDARDS
  157. .Nm
  158. should be compliant with the
  159. IEEE Std 1003.1-2024 (“POSIX.1”)
  160. specification.
  161. .Pp
  162. The
  163. .Fl c
  164. and
  165. .Fl v
  166. options are present for compatibility with other modern systems such as BusyBox and GNU coreutils.
  167. Similarly the
  168. .Fl F
  169. option was created for compatibility with
  170. .Fl -reference
  171. from GNU, BusyBox and
  172. .Nx
  173. while keeping the possibility of using short options.
  174. .Sh AUTHORS
  175. .An Haelwenn (lanodan) Monnier Aq Mt contact+utils@hacktivis.me