mirror of
https://github.com/eza-community/eza
synced 2024-10-01 13:43:56 +00:00
fix: update man files, just
This commit updates manual file templates, as well as the man-page build script using just to reflect the interim project name. This is necessary to provide manual files that are accurate. It should be somewhat easy to revert revert these changes, and is necessary to document new features as they are merged. Signed-off-by: Christina Sørensen <christina@cafkafk.com>
This commit is contained in:
Christina Sørensen
sbatial
parent
0f39fffa16
commit
1743625e5f
8
Justfile
8
Justfile
|
|
@ -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/zetta.1.md > "${CARGO_TARGET_DIR:-target}/man/zetta.1"
|
||||
pandoc --standalone -f markdown -t man man/zetta_colors.5.md > "${CARGO_TARGET_DIR:-target}/man/zetta_colors.5"
|
||||
|
||||
# build and preview the main man page (exa.1)
|
||||
@man-1-preview: man
|
||||
man "${CARGO_TARGET_DIR:-target}/man/exa.1"
|
||||
man "${CARGO_TARGET_DIR:-target}/man/zetta.1"
|
||||
|
||||
# build and preview the colour configuration man page (exa_colors.5)
|
||||
@man-5-preview: man
|
||||
man "${CARGO_TARGET_DIR:-target}/man/exa_colors.5"
|
||||
man "${CARGO_TARGET_DIR:-target}/man/zetta_colors.5"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
% exa(1) v0.9.0
|
||||
% zetta(1) v0.9.0
|
||||
|
||||
<!-- This is the exa(1) man page, written in Markdown. -->
|
||||
<!-- This is the zetta(1) man page, written in Markdown. -->
|
||||
<!-- To generate the roff version, run `just man`, -->
|
||||
<!-- and the man page will appear in the ‘target’ directory. -->
|
||||
|
||||
|
|
@ -8,15 +8,15 @@
|
|||
NAME
|
||||
====
|
||||
|
||||
exa — a modern replacement for ls
|
||||
zetta — a modern replacement for ls
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
`exa [options] [files...]`
|
||||
`zetta [options] [files...]`
|
||||
|
||||
**exa** is a modern replacement for `ls`.
|
||||
**zetta** 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.
|
||||
|
|
@ -25,16 +25,16 @@ It also has extra features not present in the original `ls`, such as viewing the
|
|||
EXAMPLES
|
||||
========
|
||||
|
||||
`exa`
|
||||
`zetta`
|
||||
: Lists the contents of the current directory in a grid.
|
||||
|
||||
`exa --oneline --reverse --sort=size`
|
||||
`zetta --oneline --reverse --sort=size`
|
||||
: Displays a list of files with the largest at the top.
|
||||
|
||||
`exa --long --header --inode --git`
|
||||
`zetta --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`
|
||||
`zetta --long --tree --level=3`
|
||||
: Displays a tree of files, three levels deep, as well as each file’s metadata.
|
||||
|
||||
|
||||
|
|
@ -104,7 +104,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 zetta was built with git support]
|
||||
: Do not list files that are ignored by Git.
|
||||
|
||||
`--group-directories-first`
|
||||
|
|
@ -180,7 +180,7 @@ These options are available when running with `--long` (`-l`):
|
|||
`-@`, `--extended`
|
||||
: List each file’s extended attributes and sizes.
|
||||
|
||||
`--git` [if exa was built with git support]
|
||||
`--git` [if zetta 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.
|
||||
|
|
@ -191,7 +191,7 @@ Directories will be shown to have the status of their contents, which is how ‘
|
|||
ENVIRONMENT VARIABLES
|
||||
=====================
|
||||
|
||||
exa responds to the following environment variables:
|
||||
Zetta responds to the following environment variables:
|
||||
|
||||
## `COLUMNS`
|
||||
|
||||
|
|
@ -199,30 +199,30 @@ 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.
|
||||
|
||||
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 zetta’s output doesn’t wrap, such as when using the `--long` view.
|
||||
|
||||
## `EXA_STRICT`
|
||||
## `ZETTA_STRICT`
|
||||
|
||||
Enables _strict mode_, which will make exa error when two command-line options are incompatible.
|
||||
Enables _strict mode_, which will make zetta 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 zetta 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.
|
||||
|
||||
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 zetta 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`
|
||||
## `ZETTA_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 (‘`zetta --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.
|
||||
|
||||
## `EXA_ICON_SPACING`
|
||||
## `ZETTA_ICON_SPACING`
|
||||
|
||||
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 zetta 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`
|
||||
|
||||
|
|
@ -230,11 +230,11 @@ Disables colours in the output (regardless of its value). Can be overridden by `
|
|||
|
||||
See `https://no-color.org/` for details.
|
||||
|
||||
## `LS_COLORS`, `EXA_COLORS`
|
||||
## `LS_COLORS`, `ZETTA_COLORS`
|
||||
|
||||
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 `zetta_colors(5)` manual page.
|
||||
|
||||
|
||||
EXIT STATUSES
|
||||
|
|
@ -253,14 +253,14 @@ EXIT STATUSES
|
|||
AUTHOR
|
||||
======
|
||||
|
||||
exa is maintained by Benjamin ‘ogham’ Sago and many other contributors.
|
||||
Zetta is a fork of exa by Benjamin ‘ogham’ Sago and many other contributors.
|
||||
|
||||
**Website:** `https://the.exa.website/` \
|
||||
**Source code:** `https://github.com/ogham/exa` \
|
||||
**Contributors:** `https://github.com/ogham/exa/graphs/contributors`
|
||||
**Exa Website:** `https://the.exa.website/` \
|
||||
**Source code:** `https://github.com/syphar/zetta` \
|
||||
**Contributors:** `https://github.com/syphar/zetta/graphs/contributors`
|
||||
|
||||
|
||||
SEE ALSO
|
||||
========
|
||||
|
||||
- `exa_colors(5)`
|
||||
- `zetta_colors(5)`
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
% exa_colors(5) v0.9.0
|
||||
% zetta_colors(5) v0.9.0
|
||||
|
||||
<!-- This is the exa_colors(5) man page, written in Markdown. -->
|
||||
<!-- This is the zetta_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. -->
|
||||
|
||||
|
|
@ -8,13 +8,13 @@
|
|||
NAME
|
||||
====
|
||||
|
||||
exa_colors — customising the file and UI colours of exa
|
||||
zetta_colors — customising the file and UI colours of exa
|
||||
|
||||
|
||||
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 `ZETTA_COLORS` environment variable can be used to customise the colours that `exa` 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:
|
||||
|
||||
|
|
@ -28,19 +28,19 @@ The key half of the pair can either be a two-letter code or a file glob, and any
|
|||
EXAMPLES
|
||||
========
|
||||
|
||||
`EXA_COLORS="uu=0:gu=0"`
|
||||
`ZETTA_COLORS="uu=0:gu=0"`
|
||||
: Disable the “current user” highlighting
|
||||
|
||||
`EXA_COLORS="da=32"`
|
||||
`ZETTA_COLORS="da=32"`
|
||||
: Turn the date column green
|
||||
|
||||
`EXA_COLORS="Vagrantfile=1;4;33"`
|
||||
`ZETTA_COLORS="Vagrantfile=1;4;33"`
|
||||
: Highlight Vagrantfiles
|
||||
|
||||
`EXA_COLORS="*.zip=38;5;125"`
|
||||
`ZETTA_COLORS="*.zip=38;5;125"`
|
||||
: Override the existing zip colour
|
||||
|
||||
`EXA_COLORS="*.md=38;5;121:*.log=38;5;248"`
|
||||
`ZETTA_COLORS="*.md=38;5;121:*.log=38;5;248"`
|
||||
: Markdown files a shade of green, log files a shade of grey
|
||||
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ LIST OF CODES
|
|||
: symlinks with no target
|
||||
|
||||
|
||||
`EXA_COLORS` can use many more:
|
||||
`ZETTA_COLORS` can use many more:
|
||||
|
||||
`ur`
|
||||
: the user-read permission bit
|
||||
|
|
@ -217,15 +217,15 @@ LIST OF CODES
|
|||
`bO`
|
||||
: the overlay style for broken symlink paths
|
||||
|
||||
Values in `EXA_COLORS` override those given in `LS_COLORS`, so you don’t need to re-write an existing `LS_COLORS` variable with proprietary extensions.
|
||||
Values in `ZETTA_COLORS` override those given in `LS_COLORS`, so you don’t need to re-write an existing `LS_COLORS` variable with proprietary extensions.
|
||||
|
||||
|
||||
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: zetta won’t just print out whichever characters are given.
|
||||
|
||||
The codes accepted by exa are:
|
||||
The codes accepted by zetta are:
|
||||
|
||||
`1`
|
||||
: for bold
|
||||
|
|
@ -259,24 +259,24 @@ 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.
|
||||
Zetta 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 zetta 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.
|
||||
You can also disable this built-in set entirely by including a `reset` entry at the beginning of `ZETTA_COLORS`.
|
||||
So setting `ZETTA_COLORS="reset:*.txt=31"` will highlight only text files; setting `EXA_COLORS="reset"` will highlight nothing.
|
||||
|
||||
|
||||
AUTHOR
|
||||
======
|
||||
|
||||
exa is maintained by Benjamin ‘ogham’ Sago and many other contributors.
|
||||
Zetta is a fork of exa by Benjamin ‘ogham’ Sago and many other contributors.
|
||||
|
||||
**Website:** `https://the.exa.website/` \
|
||||
**Source code:** `https://github.com/ogham/exa` \
|
||||
**Contributors:** `https://github.com/ogham/exa/graphs/contributors`
|
||||
**Exa Website:** `https://the.exa.website/` \
|
||||
**Source code:** `https://github.com/syphar/zetta` \
|
||||
**Contributors:** `https://github.com/syphar/zetta/graphs/contributors`
|
||||
|
||||
|
||||
SEE ALSO
|
||||
========
|
||||
|
||||
- `exa(1)`
|
||||
- `zetta(1)`
|
||||
Loading…
Reference in a new issue