Skip to content

Commit

Permalink
fix: change man pages to reffer to new binary name
Browse files Browse the repository at this point in the history
Signed-off-by: Christina Sørensen <christina@cafkafk.com>
  • Loading branch information
cafkafk committed Jul 29, 2023
1 parent a607d16 commit c92602d
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 45 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions Justfile
Expand Up @@ -98,13 +98,13 @@ all-release: build-release test-release
# build the man pages
@man:
mkdir -p "${CARGO_TARGET_DIR:-target}/man"
pandoc --standalone -f markdown -t man man/exa.1.md > "${CARGO_TARGET_DIR:-target}/man/exa.1"
pandoc --standalone -f markdown -t man man/exa_colors.5.md > "${CARGO_TARGET_DIR:-target}/man/exa_colors.5"
pandoc --standalone -f markdown -t man man/eza.1.md > "${CARGO_TARGET_DIR:-target}/man/eza.1"
pandoc --standalone -f markdown -t man man/eza_colors.5.md > "${CARGO_TARGET_DIR:-target}/man/eza_colors.5"

# build and preview the main man page (exa.1)
# build and preview the main man page (eza.1)
@man-1-preview: man
man "${CARGO_TARGET_DIR:-target}/man/exa.1"
man "${CARGO_TARGET_DIR:-target}/man/eza.1"

# build and preview the colour configuration man page (exa_colors.5)
# build and preview the colour configuration man page (eza_colors.5)
@man-5-preview: man
man "${CARGO_TARGET_DIR:-target}/man/exa_colors.5"
man "${CARGO_TARGET_DIR:-target}/man/eza_colors.5"
50 changes: 25 additions & 25 deletions man/exa.1.md → man/eza.1.md
@@ -1,22 +1,22 @@
% exa(1) v0.9.0
% eza(1) v0.9.0

<!-- This is the exa(1) man page, written in Markdown. -->
<!-- This is the eza(1) man page, written in Markdown. -->
<!-- To generate the roff version, run `just man`, -->
<!-- and the man page will appear in the ‘target’ directory. -->


NAME
====

exa — a modern replacement for ls
eza — a modern replacement for ls


SYNOPSIS
========

`exa [options] [files...]`
`eza [options] [files...]`

**exa** is a modern replacement for `ls`.
**eza** 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.
Expand All @@ -25,16 +25,16 @@ It also has extra features not present in the original `ls`, such as viewing the
EXAMPLES
========

`exa`
`eza`
: Lists the contents of the current directory in a grid.

`exa --oneline --reverse --sort=size`
`eza --oneline --reverse --sort=size`
: Displays a list of files with the largest at the top.

`exa --long --header --inode --git`
`eza --long --header --inode --git`
: Displays a table of files with a header, showing each file’s metadata, inode, and Git status.

`exa --long --tree --level=3`
`eza --long --tree --level=3`
: Displays a tree of files, three levels deep, as well as each file’s metadata.


Expand Down Expand Up @@ -107,7 +107,7 @@ Sort fields starting with a capital letter will sort uppercase before lowercase:
`-I`, `--ignore-glob=GLOBS`
: Glob patterns, pipe-separated, of files to ignore.

`--git-ignore` [if exa was built with git support]
`--git-ignore` [if eza was built with git support]
: Do not list files that are ignored by Git.

`--group-directories-first`
Expand Down Expand Up @@ -189,7 +189,7 @@ These options are available when running with `--long` (`-l`):
`-Z`, `--context`
: List each file's security context.

`--git` [if exa was built with git support]
`--git` [if eza was built with git support]
: List each file’s Git status, if tracked.

This adds a two-character column indicating the staged and unstaged statuses respectively. The status character can be ‘`-`’ for not modified, ‘`M`’ for a modified file, ‘`N`’ for a new file, ‘`D`’ for deleted, ‘`R`’ for renamed, ‘`T`’ for type-change, ‘`I`’ for ignored, and ‘`U`’ for conflicted.
Expand All @@ -200,29 +200,29 @@ Directories will be shown to have the status of their contents, which is how ‘
ENVIRONMENT VARIABLES
=====================

exa responds to the following environment variables:
eza responds to the following environment variables:

## `COLUMNS`

Overrides the width of the terminal, in characters.

For example, ‘`COLUMNS=80 exa`’ will show a grid view with a maximum width of 80 characters.
For example, ‘`COLUMNS=80 eza`’ will show a grid view with a maximum width of 80 characters.

This option won’t do anything when exa’s output doesn’t wrap, such as when using the `--long` view.
This option won’t do anything when eza’s output doesn’t wrap, such as when using the `--long` view.

## `EXA_STRICT`

Enables _strict mode_, which will make exa error when two command-line options are incompatible.
Enables _strict mode_, which will make eza error when two command-line options are incompatible.

Usually, options can override each other going right-to-left on the command line, so that exa can be given aliases: creating an alias ‘`exa=exa --sort=ext`’ then running ‘`exa --sort=size`’ with that alias will run ‘`exa --sort=ext --sort=size`’, and the sorting specified by the user will override the sorting specified by the alias.
Usually, options can override each other going right-to-left on the command line, so that eza can be given aliases: creating an alias ‘`eza=eza --sort=ext`’ then running ‘`eza --sort=size`’ with that alias will run ‘`eza --sort=ext --sort=size`’, and the sorting specified by the user will override the sorting specified by the alias.

In strict mode, the two options will not co-operate, and exa will error.
In strict mode, the two options will not co-operate, and eza will error.

This option is intended for use with automated scripts and other situations where you want to be certain you’re typing in the right command.

## `EXA_GRID_ROWS`

Limits the grid-details view (‘`exa --grid --long`’) so it’s only activated when at least the given number of rows of output would be generated.
Limits the grid-details view (‘`eza --grid --long`’) so it’s only activated when at least the given number of rows of output would be generated.

With widescreen displays, it’s possible for the grid to look very wide and sparse, on just one or two lines with none of the columns lining up.
By specifying a minimum number of rows, you can only use the view if it’s going to be worth using.
Expand All @@ -231,7 +231,7 @@ By specifying a minimum number of rows, you can only use the view if it’s goin

Specifies the number of spaces to print between an icon (see the ‘`--icons`’ option) and its file name.

Different terminals display icons differently, as they usually take up more than one character width on screen, so there’s no “standard” number of spaces that exa can use to separate an icon from text. One space may place the icon too close to the text, and two spaces may place it too far away. So the choice is left up to the user to configure depending on their terminal emulator.
Different terminals display icons differently, as they usually take up more than one character width on screen, so there’s no “standard” number of spaces that eza can use to separate an icon from text. One space may place the icon too close to the text, and two spaces may place it too far away. So the choice is left up to the user to configure depending on their terminal emulator.

## `NO_COLOR`

Expand All @@ -243,7 +243,7 @@ See `https://no-color.org/` for details.

Specifies the colour scheme used to highlight files based on their name and kind, as well as highlighting metadata and parts of the UI.

For more information on the format of these environment variables, see the `exa_colors(5)` manual page.
For more information on the format of these environment variables, see the `eza_colors(5)` manual page.


EXIT STATUSES
Expand All @@ -262,14 +262,14 @@ EXIT STATUSES
AUTHOR
======

exa is maintained by Benjamin ‘ogham’ Sago and many other contributors.
eza is maintained by Christina Sørensen and many other contributors.

**Website:** `https://the.exa.website/` \
**Source code:** `https://github.com/ogham/exa` \
**Contributors:** `https://github.com/ogham/exa/graphs/contributors`
**Source code:** `https://github.com/cafkafk/eza` \
**Contributors:** `https://github.com/cafkafk/eza/graphs/contributors`

Our infinite thanks to Benjamin ‘ogham’ Sago and all the other contributors of exa, from which eza was forked.

SEE ALSO
========

- `exa_colors(5)`
- `eza_colors(5)`
27 changes: 14 additions & 13 deletions man/exa_colors.5.md → man/eza_colors.5.md
@@ -1,20 +1,20 @@
% exa_colors(5) v0.9.0
% eza_colors(5) v0.9.0

<!-- This is the exa_colors(5) man page, written in Markdown. -->
<!-- This is the eza_colors(5) man page, written in Markdown. -->
<!-- To generate the roff version, run `just man`, -->
<!-- and the man page will appear in the ‘target’ directory. -->


NAME
====

exa_colors — customising the file and UI colours of exa
eza_colors — customising the file and UI colours of eza


SYNOPSIS
========

The `EXA_COLORS` environment variable can be used to customise the colours that `exa` uses to highlight file names, file metadata, and parts of the UI.
The `EXA_COLORS` environment variable can be used to customise the colours that `eza` uses to highlight file names, file metadata, and parts of the UI.

You can use the `dircolors` program to generate a script that sets the variable from an input file, or if you don’t mind editing long strings of text, you can just type it out directly. These variables have the following structure:

Expand Down Expand Up @@ -223,9 +223,9 @@ Values in `EXA_COLORS` override those given in `LS_COLORS`, so you don’t need
LIST OF STYLES
==============

Unlike some versions of `ls`, the given ANSI values must be valid colour codes: exa won’t just print out whichever characters are given.
Unlike some versions of `ls`, the given ANSI values must be valid colour codes: eza won’t just print out whichever characters are given.

The codes accepted by exa are:
The codes accepted by eza are:

`1`
: for bold
Expand Down Expand Up @@ -259,8 +259,8 @@ The codes accepted by exa are:

Many terminals will treat bolded text as a different colour, or at least provide the option to.

exa provides its own built-in set of file extension mappings that cover a large range of common file extensions, including documents, archives, media, and temporary files.
Any mappings in the environment variables will override this default set: running exa with `LS_COLORS="*.zip=32"` will turn zip files green but leave the colours of other compressed files alone.
eza provides its own built-in set of file extension mappings that cover a large range of common file extensions, including documents, archives, media, and temporary files.
Any mappings in the environment variables will override this default set: running eza with `LS_COLORS="*.zip=32"` will turn zip files green but leave the colours of other compressed files alone.

You can also disable this built-in set entirely by including a `reset` entry at the beginning of `EXA_COLORS`.
So setting `EXA_COLORS="reset:*.txt=31"` will highlight only text files; setting `EXA_COLORS="reset"` will highlight nothing.
Expand All @@ -269,14 +269,15 @@ So setting `EXA_COLORS="reset:*.txt=31"` will highlight only text files; setting
AUTHOR
======

exa is maintained by Benjamin ‘ogham’ Sago and many other contributors.
eza is maintained by Christina Sørensen and many other contributors.

**Website:** `https://the.exa.website/` \
**Source code:** `https://github.com/ogham/exa` \
**Contributors:** `https://github.com/ogham/exa/graphs/contributors`
**Source code:** `https://github.com/cafkafk/eza` \
**Contributors:** `https://github.com/cafkafk/eza/graphs/contributors`

Our infinite thanks to Benjamin ‘ogham’ Sago and all the other contributors of exa, from which eza was forked.


SEE ALSO
========

- `exa(1)`
- `eza(1)`

0 comments on commit c92602d

Please sign in to comment.