logo

utils-std

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

chmod.1 (2924B)

    

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