diff --git a/contrib/man/exa.1 b/contrib/man/exa.1 index c672c0a..0d393e6 100644 --- a/contrib/man/exa.1 +++ b/contrib/man/exa.1 @@ -1,117 +1,164 @@ -.TH exa "1" "7/Jun/2015" "exa 0.3.0" "User Commands" +.hy +.TH "exa" "1" "2015\-10\-18" "exa 0.4.0" "" .SH NAME -exa - a modern replacement for ls +.PP +exa \- a modern replacement for ls .SH SYNOPSIS -.B exa -[\fIOPTIONS\fR] [\fIFILES...\fR] +.PP +exa [\f[I]options\f[]] [\f[I]files\f[]]... .SH DESCRIPTION -exa is a modern replacement for ls. It uses colours for information by -default, helping you distinguish between many types of files, such as whether -you are the owner, or in the owning group. It also has extra features not -present in the original ls, such as viewing the Git status for a directory, or -recursing into directories with a tree view. - -.SH OPTIONS - +.PP +\f[C]exa\f[] is a modern replacement for \f[C]ls\f[]. +It uses colours for information by default, helping you distinguish +between many types of files, such as whether you are the owner, or in +the owning group. +It also has extra features not present in the original \f[C]ls\f[], such +as viewing the Git status for a directory, or recursing into directories +with a tree view. +.SH DISPLAY OPTIONS .TP -\fB\-?\fR, \fB\-\-help\fR -Show list of command-line options -.TP -\fB\-\-VERSION\fR -Display version of exa - -.SH FILTERING OPTIONS - -.TP -\fB\-a\fR, \fB\-\-all\fR -show dot-files -.TP -\fB\-d\fR, \fB\-\-list-dirs\fR -list directories as regular files -.TP -\fB\-\-group-directories-first\fR -list directories before other files -.TP -\fB\-L\fR, \fB\-\-level\fR DEPTH -maximum depth of recursion -.TP -\fB\-R\fR, \fB\-\-recurse\fR -recurse into directories - -.SH VIEW OPTIONS - -.TP -\fB\-1\fR, \fB\-\-oneline\fR +.B \-1, \-\-oneline display one entry per line +.RS +.RE .TP -\fB\-r\fR, \fB\-\-reverse\fR -reverse order of files +.B \-G, \-\-grid +display entries in a grid view (default) +.RS +.RE .TP -\fB\-s\fR, \fB\-\-sort\fR WORD -field to sort by -.TP -\fB\-x\fR, \fB\-\-across\fR -sort multi-column view entries across -.TP -\fB\-T\fR, \fB\-\-tree\fR -recurse into subdirectories in a tree view - -.SH LONG FORMAT OPTIONS - -.TP -\fB\-b\fR, \fB\-\-binary\fR -use binary prefixes in file sizes -.TP -\fB\-B\fR, \fB\-\-bytes\fR -list file sizes in bytes, without prefixes -.TP -\fB\-g\fR, \fB\-\-group\fR -show group as well as user -.TP -\fB\-\-git\fR -show git status -.TP -\fB\-h\fR, \fB\-\-header\fR -show a header row at the top -.TP -\fB\-H\fR, \fB\-\-links\fR -show number of hard links -.TP -\fB\-i\fR, \fB\-\-inode\fR -show each file's inode number -.TP -\fB\-l\fR, \fB\-\-long\fR +.B \-l, \-\-long display extended details and attributes +.RS +.RE .TP -\fB\-m\fR, \fB\-\-modified\fR +.B \-R, \-\-recurse +recurse into directories +.RS +.RE +.TP +.B \-T, \-\-tree +recurse into subdirectories in a tree view +.RS +.RE +.TP +.B \-x, \-\-across +sort multi\-column view entries across +.RS +.RE +.TP +.B \-\-color, \-\-colour=\f[I]WHEN\f[] +when to colourise the output (always, automatic, never) +.RS +.RE +.SH FILTERING AND SORTING OPTIONS +.TP +.B \-a, \-\-all +show dot\-files +.RS +.RE +.TP +.B \-d, \-\-list\-dirs +list directories as regular files +.RS +.RE +.TP +.B \-r, \-\-reverse +reverse order of files +.RS +.RE +.TP +.B \-s, \-\-sort=\f[I]WORD\f[] +field to sort by (name, size, extension, modified, accessed, created, +inode, none) +.RS +.RE +.TP +.B \-\-group\-directories\-first +list directories before other files +.RS +.RE +.SH LONG VIEW OPTIONS +.TP +.B \-b, \-\-binary +use binary prefixes in file sizes +.RS +.RE +.TP +.B \-B, \-\-bytes +list file sizes in bytes, without prefixes +.RS +.RE +.TP +.B \-g, \-\-group +show group as well as user +.RS +.RE +.TP +.B \-h, \-\-header +show a header row at the top +.RS +.RE +.TP +.B \-H, \-\-links +show number of hard links +.RS +.RE +.TP +.B \-i, \-\-inode +show each file\[aq]s inode number +.RS +.RE +.TP +.B \-L, \-\-level=\f[I]DEPTH\f[] +maximum depth of recursion +.RS +.RE +.TP +.B \-m, \-\-modified display timestamp of most recent modification +.RS +.RE .TP -\fB\-S\fR, \fB\-\-blocks\fR +.B \-S, \-\-blocks show number of file system blocks +.RS +.RE .TP -\fB\-t\fR, \fB\-\-time\fR WORD -which timestamp to show for a file +.B \-t, \-\-time=\f[I]WORD\f[] +which timestamp to show for a file (modified, accessed, created) +.RS +.RE .TP -\fB\-u\fR, \fB\-\-accessed\fR +.B \-u, \-\-accessed display timestamp of last access for a file +.RS +.RE .TP -\fB\-U\fR, \fB\-\-created\fR +.B \-U, \-\-created display timestamp of creation for a file -.TP -\fB\-@\fR, \fB\-\-extended\fR -display extended attribute keys and sizes - -.SH "EXAMPLES" - +.RS +.RE +.SH EXAMPLES +.PP To display a list of files, with the largest at the top: - - $ exa --reverse --sort=size - +.IP +.nf +\f[C] +exa\ \-\-reverse\ \-\-sort=size +\f[] +.fi +.PP To display a tree of files, three levels deep: - - $ exa --long --tree --level=3 - -.SH "AUTHOR" -exa is maintained by Benjamin `ogham` Sago and many other contributors. You -can view the full list at \fIhttps://github.com/ogham/exa/contributors\fR\. - +.IP +.nf +\f[C] +exa\ \-\-long\ \-\-tree\ \-\-level=3 +\f[] +.fi +.SH AUTHOR +.PP +\f[C]exa\f[] is maintained by Benjamin \[aq]ogham\[aq] Sago and many +other contributors. +You can view the full list at +.