mirror of
https://github.com/Llewellynvdm/exa.git
synced 2024-12-27 02:12:53 +00:00
README REVAMP
• Make the README look a bit nicer, with centered text and links and badges and stuff like that. Everyone knows that software is better if it has badges in its readme • Fix bug where the options list was unnaturally spaced • More OS installation commands • A couple of rephrasings
This commit is contained in:
Benjamin Sago
parent
31a2eba2fe
commit
6ef7dba160
216
README.md
216
README.md
@ -1,23 +1,41 @@
|
||||
# exa [](https://travis-ci.org/ogham/exa)
|
||||
<div align="center">
|
||||
<h1>exa</h1>
|
||||
|
||||
[exa](https://the.exa.website/) is a replacement for `ls` written in Rust.
|
||||
[exa](https://the.exa.website/) is a modern replacement for _ls_.
|
||||
|
||||
## Rationale
|
||||
**README Sections:** [Options](#options) — [Installation](#installation) — [Development](#development)
|
||||
|
||||
**exa** is a modern replacement for the command-line program `ls` that ships with Unix and Linux operating systems, with more features and better defaults. It uses colours to distinguish file types and metadata. It knows about symlinks, extended attributes, and Git. And it’s **small**, **fast**, and just one **single binary**.
|
||||
<a href="https://travis-ci.org/github/ogham/exa">
|
||||
<img src="https://travis-ci.org/ogham/exa.svg?branch=master" alt="Build status" />
|
||||
</a>
|
||||
|
||||
By deliberately making some decisions differently, exa attempts to be a more featureful, more user-friendly version of `ls`.
|
||||
|
||||
## Screenshots
|
||||
<a href="https://saythanks.io/to/ogham%40bsago.me">
|
||||
<img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" alt="Say thanks!" />
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Options
|
||||
**exa** is a modern replacement for the venerable file-listing command-line program `ls` that ships with Unix and Linux operating systems, giving it more features and better defaults.
|
||||
It uses colours to distinguish file types and metadata.
|
||||
It knows about symlinks, extended attributes, and Git.
|
||||
And it’s **small**, **fast**, and just **one single binary**.
|
||||
|
||||
exa’s options are almost, but not quite, entirely unlike `ls`'s.
|
||||
By deliberately making some decisions differently, exa attempts to be a more featureful, more user-friendly version of `ls`.
|
||||
For more information, see [exa’s website](https://the.exa.website/).
|
||||
|
||||
### Display Options
|
||||
|
||||
---
|
||||
|
||||
<a id="options">
|
||||
<h1>Command-line options</h1>
|
||||
</a>
|
||||
|
||||
exa’s options are almost, but not quite, entirely unlike `ls`’s.
|
||||
|
||||
### Display options
|
||||
|
||||
- **-1**, **--oneline**: display one entry per line
|
||||
- **-G**, **--grid**: display entries as a grid (default)
|
||||
@ -30,7 +48,7 @@ exa’s options are almost, but not quite, entirely unlike `ls`'s.
|
||||
- **--colo[u]r-scale**: highlight levels of file sizes distinctly
|
||||
- **--icons**: display icons
|
||||
|
||||
### Filtering Options
|
||||
### Filtering options
|
||||
|
||||
- **-a**, **--all**: show hidden and 'dot' files
|
||||
- **-d**, **--list-dirs**: list directories like regular files
|
||||
@ -44,91 +62,175 @@ exa’s options are almost, but not quite, entirely unlike `ls`'s.
|
||||
|
||||
Pass the `--all` option twice to also show the `.` and `..` directories.
|
||||
|
||||
### Long View Options
|
||||
### Long view options
|
||||
|
||||
These options are available when running with --long (`-l`):
|
||||
These options are available when running with `--long` (`-l`):
|
||||
|
||||
- **-b**, **--binary**: list file sizes with binary prefixes
|
||||
- **-B**, **--bytes**: list file sizes in bytes, without any prefixes
|
||||
- **-g**, **--group**: list each file's group
|
||||
- **-g**, **--group**: list each file’s group
|
||||
- **-h**, **--header**: add a header row to each column
|
||||
- **-H**, **--links**: list each file's number of hard links
|
||||
- **-i**, **--inode**: list each file's inode number
|
||||
- **-H**, **--links**: list each file’s number of hard links
|
||||
- **-i**, **--inode**: list each file’s inode number
|
||||
- **-m**, **--modified**: use the modified timestamp field
|
||||
- **-S**, **--blocks**: list each file's number of file system blocks
|
||||
- **-S**, **--blocks**: list each file’s number of file system blocks
|
||||
- **-t**, **--time=(field)**: which timestamp field to use
|
||||
- **-u**, **--accessed**: use the accessed timestamp field
|
||||
- **-U**, **--created**: use the created timestamp field
|
||||
- **-@**, **--extended**: list each file's extended attributes and sizes
|
||||
- **-@**, **--extended**: list each file’s extended attributes and sizes
|
||||
- **--changed**: use the changed timestamp field
|
||||
- **--git**: list each file's Git status, if tracked or ignored
|
||||
- **--git**: list each file’s Git status, if tracked or ignored
|
||||
- **--time-style**: how to format timestamps
|
||||
- **--no-permissions**: suppress the permissions field
|
||||
- **--no-filesize**: suppress the filesize field
|
||||
- **--no-user**: suppress the user field
|
||||
- **--no-time**: suppress the time field
|
||||
|
||||
Some of the options accept parameters:
|
||||
|
||||
- Valid **--color** options are **always**, **automatic**, and **never**.
|
||||
- Valid sort fields are **accessed**, **changed**, **created**, **extension**, **Extension**, **inode**, **modified**, **name**, **Name**, **size**, **type**, and **none**. Fields starting with a capital letter sort uppercase before lowercase. The modified field has the aliases **date**, **time**, and **newest**, while its reverse has the aliases **age** and **oldest**.
|
||||
- Valid time fields are **modified**, **changed**, **accessed**, and **created**.
|
||||
- Valid time styles are **default**, **iso**, **long-iso**, and **full-iso**.
|
||||
|
||||
|
||||
## Installation
|
||||
---
|
||||
|
||||
exa is written in [Rust](http://www.rust-lang.org). You will need rustc version 1.35.0 or higher. The recommended way to install Rust is from the official download page.
|
||||
Once you have it set up, a simple `make install` will compile exa and install it into `/usr/local/bin`.
|
||||
<a id="installation">
|
||||
<h1>Installation</h1>
|
||||
</a>
|
||||
|
||||
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`.
|
||||
exa is available for macOS and Linux.
|
||||
More information on how to install exa is available on [the Installation page](https://the.exa.website/install).
|
||||
|
||||
If you intend to compile for musl you will need to use the flag vendored-openssl if you want to get the Git feature working: `cargo build --release --target=x86_64-unknown-linux-musl --features vendored-openssl,git`
|
||||
### Arch Linux
|
||||
|
||||
### Cargo Install
|
||||
On Arch, install the [`exa`](https://www.archlinux.org/packages/community/x86_64/exa/) package.
|
||||
|
||||
If you’re using a recent version of Cargo (0.5.0 or higher), you can use the `cargo install` command:
|
||||
$ pacman -S exa
|
||||
|
||||
cargo install exa
|
||||
### Debian
|
||||
|
||||
or:
|
||||
On Debian, install the [`exa`](https://packages.debian.org/unstable/exa) package.
|
||||
For now, exa is in the _unstable_ repository.
|
||||
|
||||
cargo install --no-default-features exa
|
||||
|
||||
Cargo will build the `exa` binary and place it in `$HOME/.cargo` (this location can be overridden by setting the `--root` option).
|
||||
|
||||
### Homebrew
|
||||
|
||||
If you're using [homebrew](https://brew.sh/), you can use the `brew install` command:
|
||||
|
||||
brew install exa
|
||||
|
||||
or:
|
||||
|
||||
brew install exa --without-git
|
||||
|
||||
[Formulae](https://github.com/Homebrew/homebrew-core/blob/master/Formula/exa.rb)
|
||||
$ apt install exa
|
||||
|
||||
### Fedora
|
||||
|
||||
You can install the `exa` package from the official Fedora repositories by running:
|
||||
On Fedora, install the [`exa`](https://src.fedoraproject.org/modules/exa) package.
|
||||
|
||||
dnf install exa
|
||||
$ dnf install exa
|
||||
|
||||
### Gentoo
|
||||
|
||||
On Gentoo, install the [`sys-apps/exa`](https://packages.gentoo.org/packages/sys-apps/exa) package.
|
||||
|
||||
$ emerge sys-apps/exa
|
||||
|
||||
### Homebrew
|
||||
|
||||
If you’re using [Homebrew](https://brew.sh/) on macOS, install the [`exa`](http://formulae.brew.sh/formula/exa) formula.
|
||||
|
||||
$ brew install exa
|
||||
|
||||
### MacPorts
|
||||
|
||||
If you're using [MacPorts](https://www.macports.org/) on macOS, install the [`exa`](https://ports.macports.org/port/exa/summary) port.
|
||||
|
||||
$ port install exa
|
||||
|
||||
### Nix
|
||||
|
||||
`exa` is also installable through [the derivation](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/exa/default.nix) using the [nix package manager](https://nixos.org/nix/) by running:
|
||||
On nixOS, install the [`exa`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/exa/default.nix) package.
|
||||
|
||||
nix-env -i exa
|
||||
$ nix-env -i exa
|
||||
|
||||
## Testing with Vagrant
|
||||
### openSUSE
|
||||
|
||||
On openSUSE, install the [`exa`](https://software.opensuse.org/package/exa) package.
|
||||
|
||||
$ zypper install exa
|
||||
|
||||
### Ubuntu
|
||||
|
||||
On Ubuntu 20.10 (Groovy Gorilla) and later, install the [`exa`](https://packages.ubuntu.com/groovy/exa) package.
|
||||
|
||||
$ apt install exa
|
||||
|
||||
### Void Linux
|
||||
|
||||
On Void Linux, install the [`exa`](https://github.com/void-linux/void-packages/blob/master/srcpkgs/exa/template) package.
|
||||
|
||||
$ xbps-install -S exa
|
||||
|
||||
### Manual installation from GitHub
|
||||
|
||||
Compiled binary versions of exa are uploaded to GitHub when a release is made.
|
||||
You can install exa manually by [downloading a release](https://github.com/ogham/exa/releases), extracting it, and copying the binary to a directory in your `$PATH`, such as `/usr/local/bin`.
|
||||
|
||||
For more information, see the [Manual Installation page](https://the.exa.website/install/linux#manual).
|
||||
|
||||
### Cargo
|
||||
|
||||
If you already have a Rust environment set up, you can use the `cargo install` command:
|
||||
|
||||
$ cargo install exa
|
||||
|
||||
Cargo will build the `exa` binary and place it in `$HOME/.cargo`.
|
||||
|
||||
To build without Git support, run `cargo install --no-default-features exa` is also available, if the requisite dependencies are not installed.
|
||||
|
||||
|
||||
---
|
||||
|
||||
<a id="development">
|
||||
<h1>Development
|
||||
|
||||
<a href="https://blog.rust-lang.org/2020/03/12/Rust-1.42.html">
|
||||
<img src="https://img.shields.io/badge/rustc-1.42+-lightgray.svg" alt="Rust 1.42+" />
|
||||
</a>
|
||||
|
||||
<a href="https://github.com/ogham/exa/blob/master/LICENCE">
|
||||
<img src="https://img.shields.io/badge/licence-MIT-green" alt="MIT Licence" />
|
||||
</a>
|
||||
</h1></a>
|
||||
|
||||
exa is written in [Rust](https://www.rust-lang.org/).
|
||||
You will need rustc version 1.42.0 or higher.
|
||||
The recommended way to install Rust for development is from the [official download page](https://www.rust-lang.org/tools/install), using rustup.
|
||||
|
||||
Once Rust is installed, you can compile exa with Cargo:
|
||||
|
||||
$ cargo build
|
||||
$ cargo test
|
||||
|
||||
The [just](https://github.com/casey/just) command runner can be used to run some helpful development commands, in a manner similar to `make`.
|
||||
|
||||
exa depends on [libgit2](https://github.com/rust-lang/git2-rs) for certain features.
|
||||
If you’re unable to compile libgit2, you can opt out of Git support by running `cargo build --no-default-features`.
|
||||
|
||||
If you intend to compile for musl, you will need to use the flag `vendored-openssl` if you want to get the Git feature working.
|
||||
The full command is `cargo build --release --target=x86_64-unknown-linux-musl --features vendored-openssl,git`.
|
||||
|
||||
For more information, see the [Building from Source page](https://the.exa.website/install/source).
|
||||
|
||||
|
||||
### Testing with Vagrant
|
||||
|
||||
exa uses [Vagrant][] to configure virtual machines for testing.
|
||||
|
||||
Programs such as exa that are basically interfaces to the system are [notoriously difficult to test][testing]. Although the internal components have unit tests, it’s impossible to do a complete end-to-end test without mandating the current user’s name, the time zone, the locale, and directory structure to test. (And yes, these tests are worth doing. I have missed an edge case on more than one occasion.)
|
||||
Programs such as exa that are basically interfaces to the system are [notoriously difficult to test][testing].
|
||||
Although the internal components have unit tests, it’s impossible to do a complete end-to-end test without mandating the current user’s name, the time zone, the locale, and directory structure to test.
|
||||
(And yes, these tests are worth doing. I have missed an edge case on many an occasion.)
|
||||
|
||||
The initial attempt to solve the problem was just to create a directory of “awkward” test cases, run exa on it, and make sure it produced the correct output. But even this output would change if, say, the user’s locale formats dates in a different way. These can be mocked inside the code, but at the cost of making that code more complicated to read and understand.
|
||||
The initial attempt to solve the problem was just to create a directory of “awkward” test cases, run exa on it, and make sure it produced the correct output.
|
||||
But even this output would change if, say, the user’s locale formats dates in a different way.
|
||||
These can be mocked inside the code, but at the cost of making that code more complicated to read and understand.
|
||||
|
||||
An alternative solution is to fake *everything*: create a virtual machine with a known state and run the tests on *that*. This is what Vagrant does. Although it takes a while to download and set up, it gives everyone the same development environment to test for any obvious regressions.
|
||||
An alternative solution is to fake *everything*: create a virtual machine with a known state and run the tests on *that*.
|
||||
This is what Vagrant does.
|
||||
Although it takes a while to download and set up, it gives everyone the same development environment to test for any obvious regressions.
|
||||
|
||||
[Vagrant]: https://www.vagrantup.com/
|
||||
[testing]: https://eev.ee/blog/2016/08/22/testing-for-people-who-hate-testing/#troublesome-cases
|
||||
@ -137,7 +239,8 @@ First, initialise the VM:
|
||||
|
||||
host$ vagrant up
|
||||
|
||||
The first command downloads the virtual machine image, and then runs our provisioning script, which installs Rust, exa’s dependencies, configures the environment, and generates some awkward files and folders to use as test cases. This takes some time, but it does write to output occasionally. Once this is done, you can SSH in, and build and test:
|
||||
The first command downloads the virtual machine image, and then runs our provisioning script, which installs Rust and exa’s build-time dependencies, configures the environment, and generates some awkward files and folders to use as test cases.
|
||||
Once this is done, you can SSH in, and build and test:
|
||||
|
||||
host$ vagrant ssh
|
||||
vm$ cd /vagrant
|
||||
@ -145,7 +248,6 @@ The first command downloads the virtual machine image, and then runs our provisi
|
||||
vm$ ./xtests/run
|
||||
All the tests passed!
|
||||
|
||||
|
||||
### Running without Vagrant
|
||||
|
||||
Of course, the drawback of having a standard development environment is that you stop noticing bugs that occur outside of it. For this reason, Vagrant isn’t a *necessary* development step — it’s there if you’d like to use it, but exa still gets used and tested on other platforms. It can still be built and compiled on any target triple that it supports, VM or no VM, with `cargo build` and `cargo test`.
|
||||
Of course, the drawback of having a standard development environment is that you stop noticing bugs that occur outside of it.
|
||||
For this reason, Vagrant isn’t a *necessary* development step — it’s there if you’d like to use it, but exa still gets used and tested on other platforms.
|
||||
It can still be built and compiled on any target triple that it supports, VM or no VM, with `cargo build` and `cargo test`.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user