Llewellyn/exa
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/exa.git synced 2024-11-22 20:15:11 +00:00
Code Issues Projects Releases Wiki Activity

Update man page with new options

Browse Source
This commit is contained in:
Ben S 2015-06-07 16:45:58 +01:00
parent 8ce694982c
commit aa6f4a846a
2 changed files with 117 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
contrib/man/exa.1 Normal file
View File

@ -0,0 +1,117 @@
.TH exa "1" "7/Jun/2015" "exa 0.3.0" "User Commands"
.SH NAME
exa - a modern replacement for ls
.SH SYNOPSIS
.B exa
[\fIOPTIONS\fR] [\fIFILES...\fR]
.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
.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
display one entry per line
.TP
\fB\-r\fR, \fB\-\-reverse\fR
reverse order of files
.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
display extended details and attributes
.TP
\fB\-m\fR, \fB\-\-modified\fR
display timestamp of most recent modification
.TP
\fB\-S\fR, \fB\-\-blocks\fR
show number of file system blocks
.TP
\fB\-t\fR, \fB\-\-time\fR WORD
which timestamp to show for a file
.TP
\fB\-u\fR, \fB\-\-accessed\fR
display timestamp of last access for a file
.TP
\fB\-U\fR, \fB\-\-created\fR
display timestamp of creation for a file
.TP
\fB\-@\fR, \fB\-\-extended\fR
display extended attribute keys and sizes
.SH "EXAMPLES"
To display a list of files, with the largest at the top:
$ exa --reverse --sort=size
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\.

112
man/exa.1
View File

@ -1,112 +0,0 @@
.TH EXA "1" "February 2015" "exa 0.1.0" "User Commands"
.SH NAME
exa \- A replacement for ls with git integration
.SH SYNOPSIS
.B exa
[\fIOPTIONS\fR] [\fIFILES...\fR]
.SH DESCRIPTION
exa is a replacement for ls, written in Rust. If built with libgit2, it includes git integration and can display relevant information when used in git repositories.
.SH OPTIONS
.TP
\fB\-?\fR, \fB\-\-help\fR
Display a help message
.TP
\fB\-@\fR, \fB\-\-extended\fR
Display extended attribute keys and sizes in long (-l) output.
.TP
\fB\-1\fR, \fB\-\-oneline\fR
Display one entry per line.
.TP
\fB\-a\fR, \fB\-\-all\fR
Display entries whose names begin with a dot (.).
.TP
\fB\-b\fR, \fB\-\-binary\fR
Use binary prefixes in file sizes.
.TP
\fB\-B\fR, \fB\-\-bytes\fR
Display file sizes in bytes, without prefixes.
.TP
\fB\-d\fR, \fB\-\-list\-dirs\fR
Display directories as regular files.
.TP
\fB\-g\fR, \fB\-\-group\fR
Display each entry's group as well as user.
.TP
\fB\-h\fR, \fB\-\-header\fR
Display a header row at the top of the output.
.TP
\fB\-H\fR, \fB\-\-links\fR
Display each entry's number of hard links.
.TP
\fB\-i\fR, \fB\-\-inode\fR
Display each entry's inode number.
.TP
\fB\-l\fR, \fB\-\-long\fR
Display extended details and attributes.
.TP
\fB\-m\fR, \fB\-\-modified\fR
Display timestamps for each entry's most recent modification.
.TP
\fB\-r\fR, \fB\-\-reverse\fR
Reverse the order of output.
.TP
\fB\-R\fR, \fB\-\-recurse\fR
Recurse into directories.
.TP
\fB\-s\fR, \fB\-\-sort\fR ATTRIBUTE
Sort output by a given attribute (name, size, ext, inode, modified, created, accessed, or none).
.TP
\fB\-S\fR, \fB\-\-blocks\fR
Display number of file system blocks.
.TP
\fB\-t\fR, \fB\-\-time\fR TIMESTAMP
Change the timestamp displayed for each entry (created, modified, or accessed)
.TP
\fB\-T\fR, \fB\-\-tree\fR
Recurse into directories in a tree view.
.TP
\fB\-u\fR, \fB\-\-accessed\fR
Display each entry's time of last access.
.TP
\fB\-U\fR, \fB\-\-created\fR
Display each entry's time of creation.
.TP
\fB\-x\fR, \fB\-\-across\fR
Sort multi-column output horizontally instead of vertically.
.SH "EXAMPLES"
To organize a list of files with the largest files at the top:
$ exa -lrs size
.SH "SEE ALSO"
ls
.SH "AUTHOR"
exa is maintained by Benjamin Sago. A full list of contributors can be found at \fIhttps://github.com/ogham/exa/contributors\fR\.