Experimenting with making pretty man pages on paper.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

259 lines
7.7 KiB

  1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
  2. .TH LS "1" "September 2019" "GNU coreutils 8.30" "User Commands"
  3. .SH NAME
  4. ls \- list directory contents
  5. .SH SYNOPSIS
  6. .B ls
  7. [\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
  8. .SH DESCRIPTION
  9. .\" Add any additional description here
  10. .PP
  11. List information about the FILEs (the current directory by default).
  12. Sort entries alphabetically if none of \fB\-cftuvSUX\fR nor \fB\-\-sort\fR is specified.
  13. .PP
  14. Mandatory arguments to long options are mandatory for short options too.
  15. .TP
  16. \fB\-a\fR, \fB\-\-all\fR
  17. do not ignore entries starting with .
  18. .TP
  19. \fB\-A\fR, \fB\-\-almost\-all\fR
  20. do not list implied . and ..
  21. .TP
  22. \fB\-\-author\fR
  23. with \fB\-l\fR, print the author of each file
  24. .TP
  25. \fB\-b\fR, \fB\-\-escape\fR
  26. print C\-style escapes for nongraphic characters
  27. .TP
  28. \fB\-\-block\-size\fR=\fI\,SIZE\/\fR
  29. with \fB\-l\fR, scale sizes by SIZE when printing them;
  30. e.g., '\-\-block\-size=M'; see SIZE format below
  31. .TP
  32. \fB\-B\fR, \fB\-\-ignore\-backups\fR
  33. do not list implied entries ending with ~
  34. .TP
  35. \fB\-c\fR
  36. with \fB\-lt\fR: sort by, and show, ctime (time of last
  37. modification of file status information);
  38. with \fB\-l\fR: show ctime and sort by name;
  39. otherwise: sort by ctime, newest first
  40. .TP
  41. \fB\-C\fR
  42. list entries by columns
  43. .TP
  44. \fB\-\-color\fR[=\fI\,WHEN\/\fR]
  45. colorize the output; WHEN can be 'always' (default
  46. if omitted), 'auto', or 'never'; more info below
  47. .TP
  48. \fB\-d\fR, \fB\-\-directory\fR
  49. list directories themselves, not their contents
  50. .TP
  51. \fB\-D\fR, \fB\-\-dired\fR
  52. generate output designed for Emacs' dired mode
  53. .TP
  54. \fB\-f\fR
  55. do not sort, enable \fB\-aU\fR, disable \fB\-ls\fR \fB\-\-color\fR
  56. .TP
  57. \fB\-F\fR, \fB\-\-classify\fR
  58. append indicator (one of */=>@|) to entries
  59. .TP
  60. \fB\-\-file\-type\fR
  61. likewise, except do not append '*'
  62. .TP
  63. \fB\-\-format\fR=\fI\,WORD\/\fR
  64. across \fB\-x\fR, commas \fB\-m\fR, horizontal \fB\-x\fR, long \fB\-l\fR,
  65. single\-column \fB\-1\fR, verbose \fB\-l\fR, vertical \fB\-C\fR
  66. .TP
  67. \fB\-\-full\-time\fR
  68. like \fB\-l\fR \fB\-\-time\-style\fR=\fI\,full\-iso\/\fR
  69. .TP
  70. \fB\-g\fR
  71. like \fB\-l\fR, but do not list owner
  72. .TP
  73. \fB\-\-group\-directories\-first\fR
  74. group directories before files;
  75. .IP
  76. can be augmented with a \fB\-\-sort\fR option, but any
  77. use of \fB\-\-sort\fR=\fI\,none\/\fR (\fB\-U\fR) disables grouping
  78. .TP
  79. \fB\-G\fR, \fB\-\-no\-group\fR
  80. in a long listing, don't print group names
  81. .TP
  82. \fB\-h\fR, \fB\-\-human\-readable\fR
  83. with \fB\-l\fR and \fB\-s\fR, print sizes like 1K 234M 2G etc.
  84. .TP
  85. \fB\-\-si\fR
  86. likewise, but use powers of 1000 not 1024
  87. .TP
  88. \fB\-H\fR, \fB\-\-dereference\-command\-line\fR
  89. follow symbolic links listed on the command line
  90. .TP
  91. \fB\-\-dereference\-command\-line\-symlink\-to\-dir\fR
  92. follow each command line symbolic link
  93. .IP
  94. that points to a directory
  95. .TP
  96. \fB\-\-hide\fR=\fI\,PATTERN\/\fR
  97. do not list implied entries matching shell PATTERN
  98. (overridden by \fB\-a\fR or \fB\-A\fR)
  99. .TP
  100. \fB\-\-hyperlink\fR[=\fI\,WHEN\/\fR]
  101. hyperlink file names; WHEN can be 'always'
  102. (default if omitted), 'auto', or 'never'
  103. .TP
  104. \fB\-\-indicator\-style\fR=\fI\,WORD\/\fR
  105. append indicator with style WORD to entry names:
  106. none (default), slash (\fB\-p\fR),
  107. file\-type (\fB\-\-file\-type\fR), classify (\fB\-F\fR)
  108. .TP
  109. \fB\-i\fR, \fB\-\-inode\fR
  110. print the index number of each file
  111. .TP
  112. \fB\-I\fR, \fB\-\-ignore\fR=\fI\,PATTERN\/\fR
  113. do not list implied entries matching shell PATTERN
  114. .TP
  115. \fB\-k\fR, \fB\-\-kibibytes\fR
  116. default to 1024\-byte blocks for disk usage;
  117. used only with \fB\-s\fR and per directory totals
  118. .TP
  119. \fB\-l\fR
  120. use a long listing format
  121. .TP
  122. \fB\-L\fR, \fB\-\-dereference\fR
  123. when showing file information for a symbolic
  124. link, show information for the file the link
  125. references rather than for the link itself
  126. .TP
  127. \fB\-m\fR
  128. fill width with a comma separated list of entries
  129. .TP
  130. \fB\-n\fR, \fB\-\-numeric\-uid\-gid\fR
  131. like \fB\-l\fR, but list numeric user and group IDs
  132. .TP
  133. \fB\-N\fR, \fB\-\-literal\fR
  134. print entry names without quoting
  135. .TP
  136. \fB\-o\fR
  137. like \fB\-l\fR, but do not list group information
  138. .TP
  139. \fB\-p\fR, \fB\-\-indicator\-style\fR=\fI\,slash\/\fR
  140. append / indicator to directories
  141. .TP
  142. \fB\-q\fR, \fB\-\-hide\-control\-chars\fR
  143. print ? instead of nongraphic characters
  144. .TP
  145. \fB\-\-show\-control\-chars\fR
  146. show nongraphic characters as\-is (the default,
  147. unless program is 'ls' and output is a terminal)
  148. .TP
  149. \fB\-Q\fR, \fB\-\-quote\-name\fR
  150. enclose entry names in double quotes
  151. .TP
  152. \fB\-\-quoting\-style\fR=\fI\,WORD\/\fR
  153. use quoting style WORD for entry names:
  154. literal, locale, shell, shell\-always,
  155. shell\-escape, shell\-escape\-always, c, escape
  156. (overrides QUOTING_STYLE environment variable)
  157. .TP
  158. \fB\-r\fR, \fB\-\-reverse\fR
  159. reverse order while sorting
  160. .TP
  161. \fB\-R\fR, \fB\-\-recursive\fR
  162. list subdirectories recursively
  163. .TP
  164. \fB\-s\fR, \fB\-\-size\fR
  165. print the allocated size of each file, in blocks
  166. .TP
  167. \fB\-S\fR
  168. sort by file size, largest first
  169. .TP
  170. \fB\-\-sort\fR=\fI\,WORD\/\fR
  171. sort by WORD instead of name: none (\fB\-U\fR), size (\fB\-S\fR),
  172. time (\fB\-t\fR), version (\fB\-v\fR), extension (\fB\-X\fR)
  173. .TP
  174. \fB\-\-time\fR=\fI\,WORD\/\fR
  175. with \fB\-l\fR, show time as WORD instead of default
  176. modification time: atime or access or use (\fB\-u\fR);
  177. ctime or status (\fB\-c\fR); also use specified time
  178. as sort key if \fB\-\-sort\fR=\fI\,time\/\fR (newest first)
  179. .TP
  180. \fB\-\-time\-style\fR=\fI\,TIME_STYLE\/\fR
  181. time/date format with \fB\-l\fR; see TIME_STYLE below
  182. .TP
  183. \fB\-t\fR
  184. sort by modification time, newest first
  185. .TP
  186. \fB\-T\fR, \fB\-\-tabsize\fR=\fI\,COLS\/\fR
  187. assume tab stops at each COLS instead of 8
  188. .TP
  189. \fB\-u\fR
  190. with \fB\-lt\fR: sort by, and show, access time;
  191. with \fB\-l\fR: show access time and sort by name;
  192. otherwise: sort by access time, newest first
  193. .TP
  194. \fB\-U\fR
  195. do not sort; list entries in directory order
  196. .TP
  197. \fB\-v\fR
  198. natural sort of (version) numbers within text
  199. .TP
  200. \fB\-w\fR, \fB\-\-width\fR=\fI\,COLS\/\fR
  201. set output width to COLS. 0 means no limit
  202. .TP
  203. \fB\-x\fR
  204. list entries by lines instead of by columns
  205. .TP
  206. \fB\-X\fR
  207. sort alphabetically by entry extension
  208. .TP
  209. \fB\-Z\fR, \fB\-\-context\fR
  210. print any security context of each file
  211. .TP
  212. \fB\-1\fR
  213. list one file per line. Avoid '\en' with \fB\-q\fR or \fB\-b\fR
  214. .TP
  215. \fB\-\-help\fR
  216. display this help and exit
  217. .TP
  218. \fB\-\-version\fR
  219. output version information and exit
  220. .PP
  221. The SIZE argument is an integer and optional unit (example: 10K is 10*1024).
  222. Units are K,M,G,T,P,E,Z,Y (powers of 1024) or KB,MB,... (powers of 1000).
  223. .PP
  224. The TIME_STYLE argument can be full\-iso, long\-iso, iso, locale, or +FORMAT.
  225. FORMAT is interpreted like in date(1). If FORMAT is FORMAT1<newline>FORMAT2,
  226. then FORMAT1 applies to non\-recent files and FORMAT2 to recent files.
  227. TIME_STYLE prefixed with 'posix\-' takes effect only outside the POSIX locale.
  228. Also the TIME_STYLE environment variable sets the default style to use.
  229. .PP
  230. Using color to distinguish file types is disabled both by default and
  231. with \fB\-\-color\fR=\fI\,never\/\fR. With \fB\-\-color\fR=\fI\,auto\/\fR, ls emits color codes only when
  232. standard output is connected to a terminal. The LS_COLORS environment
  233. variable can change the settings. Use the dircolors command to set it.
  234. .SS "Exit status:"
  235. .TP
  236. 0
  237. if OK,
  238. .TP
  239. 1
  240. if minor problems (e.g., cannot access subdirectory),
  241. .TP
  242. 2
  243. if serious trouble (e.g., cannot access command\-line argument).
  244. .SH AUTHOR
  245. Written by Richard M. Stallman and David MacKenzie.
  246. .SH "REPORTING BUGS"
  247. GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
  248. .br
  249. Report ls translation bugs to <https://translationproject.org/team/>
  250. .SH COPYRIGHT
  251. Copyright \(co 2018 Free Software Foundation, Inc.
  252. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
  253. .br
  254. This is free software: you are free to change and redistribute it.
  255. There is NO WARRANTY, to the extent permitted by law.
  256. .SH "SEE ALSO"
  257. Full documentation at: <https://www.gnu.org/software/coreutils/ls>
  258. .br
  259. or available locally via: info \(aq(coreutils) ls invocation\(aq