logo

utils-std

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

chmod.1 (3258B)

    

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