From 5cd1d6a13c51f973926a266b29560b3897473b87 Mon Sep 17 00:00:00 2001 From: Ben S Date: Thu, 19 Nov 2015 13:21:49 +0000 Subject: [PATCH] Update readme with latest option set --- README.md | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e631251..6845a7a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ Works on all recent Rust versions >= 1.4.0. + ## Screenshot ![Screenshot of exa](https://raw.githubusercontent.com/ogham/exa/master/screenshot.png) @@ -11,46 +12,54 @@ Works on all recent Rust versions >= 1.4.0. ## Options -exa's options are similar, but not exactly the same, as `ls`. +exa’s options are similar, but not exactly the same, as `ls`. + +### Display Options + +- **-1**, **--oneline**: display one entry per line +- **-G**, **--grid**: display entries in a grid view (default) +- **-l**, **--long**: display extended details and attributes +- **-R**, **--recurse**: recurse into directories +- **-T**, **--tree**: recurse into subdirectories in a tree view +- **-x**, **--across**: sort multi-column view entries across +- **--color**, **--colour**: when to colourise the output ### Filtering Options - **-a**, **--all**: show dot files - **-d**, **--list-dirs**: list directories as regular files -- **--group-directories-first**: list directories before other files - **-L**, **--level=(depth)**: maximum depth of recursion -- **-R**, **--recurse**: recurse into subdirectories - -### View Options - -- **-1**, **--oneline**: display one entry per line - **-r**, **--reverse**: reverse sort order - **-s**, **--sort=(field)**: field to sort by -- **-x**, **--across**: sort multi-column view entries across -- **-T**, **--tree**: recurse into subdirectories in a tree view +- **--group-directories-first**: list directories before other files -You can sort by **name**, **size**, **ext**, **inode**, **modified**, **created**, **accessed**, or **none**. +### Long View Options -### Long Format +These options are available when running with --long (`-l`): - **-b**, **--binary**: use binary (power of two) file sizes - **-B**, **--bytes**: list file sizes in bytes, without prefixes - **-g**, **--group**: show group as well as user -- **--git**: show git status (depends on libgit2, see below) - **-h**, **--header**: show a header row - **-H**, **--links**: show number of hard links column - **-i**, **--inode**: show inode number column -- **-l**, **--long**: display extended details and attributes - **-m**, **--modified**: display timestamp of most recent modification - **-S**, **--blocks**: show number of file system blocks - **-t**, **--time=(field)**: which timestamp to show for a file - **-u**, **--accessed**: display timestamp of last access for a file - **-U**, **--created**: display timestamp of creation of a file - **-@**, **--extended**: display extended attribute keys and sizes +- **--git**: show Git status for a file + +Accepted **--color** options are **always**, **automatic**, and **never**. +Valid sort fields are **name**, **size**, **extension**, **modified**, **accessed**, **created**, **inode**, and **none**. +Valid time fields are **modified**, **accessed**, and **created**. ## Installation -exa is written in [Rust](http://www.rust-lang.org). Once you have it set up, a simple `make install` will compile exa and install it into `/usr/local/bin`. +exa is written in [Rust](http://www.rust-lang.org). +Once you have it set up, a simple `make install` will compile exa and install it into `/usr/local/bin`. -exa depends on [libgit2](https://github.com/alexcrichton/git2-rs) for certain features. If you're unable to compile libgit2, you can opt out of Git support by passing `--no-default-features` to Cargo. +exa depends on [libgit2](https://github.com/alexcrichton/git2-rs) for certain features. +If you’re unable to compile libgit2, you can opt out of Git support by running `cargo build --release --no-default-features`.