diff options
author | ed neville <ed@s5h.net> | 2021-01-17 19:44:20 +0000 |
---|---|---|
committer | Abin Simon <abinsimon10@gmail.com> | 2021-01-31 09:41:04 +0530 |
commit | db87726598ef4eaa1ab9079482759d4e9659d15a (patch) | |
tree | dd22f13321c69949e35423ee18d49a65de73ead3 | |
parent | 3c342f68b041346e5ced8473418f21890d459288 (diff) |
Adding lsd man page in markdown format
* lsd.md to produce man page when used with pandoc.
-rw-r--r-- | CHANGELOG.md | 1 | ||||
-rw-r--r-- | doc/lsd.md | 142 |
2 files changed, 143 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index eaef26b..a166bf9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Add support for changing the string between icon and name from [Finn Hediger](https://github.com/orangefran) [#363](https://github.com/Peltoche/lsd/issues/363) - Add support for `TIME_STYLE` environment variable from [999eagle](https://github.com/999eagle) +- Add man page from [edneville](https://github.com/edneville) ### Changed ### Fixed - Fix handling blocks passed without -l in cli from [meain](https://github.com/meain) diff --git a/doc/lsd.md b/doc/lsd.md new file mode 100644 index 0000000..19ff798 --- /dev/null +++ b/doc/lsd.md @@ -0,0 +1,142 @@ +--- +title: lsd +section: 1 +header: User Manual +footer: lsd <version> +date: <date> +--- + +# NAME + +lsd - LSDeluxe + +# SYNOPSIS + +`lsd [FLAGS] [OPTIONS] [--] [FILE]...` + +# DESCRIPTION + +lsd is a ls command with a lot of pretty colours and some other stuff to enrich and enhance the directory listing experience. + +# OPTIONS + +`-a`, `--all` +: Do not ignore entries starting with **.** + +`-A`, `--almost-all` +: Do not list implied **.** and **..** + +`--classic` +: Enable classic mode (no colours or icons) + +`-L`, `--dereference` +: When showing file information for a symbolic link, show information for the file the link references rather than for the link itself + +`-d`, `--directory-only` +: Display directories themselves, and not their contents (recursively when used with --tree) + +`-X`, `--extensionsort` +: Sort by file extension + +`--help` +: Prints help information + +`-h`, `--human-readable` +: For ls compatibility purposes ONLY, currently set by default + +`--ignore-config` +: Ignore the configuration file + +`-F`, `--classify` +: Append indicator (one of \*/=>@|) at the end of the file names + +`-i`, `--inode` +: Display the index number of each file + +`-l`, `--long` +: Display extended file metadata as a table + +`--no-symlink` +: Do not display symlink target + +`-1`, `--oneline` +: Display one entry per line + +`-R`, `--recursive` +: Recurse into directories + +`-r`, `--reverse` +: Reverse the order of the sort + +`-S`, `--sizesort` +: Sort by size + +`-t`, `--timesort` +: Sort by time modified + +`--total-size` +: Display the total size of directories + +`--tree` +: Recurse into directories and present the result as a tree + +`-V`, `--version` +: Prints version information + +`-v`, `--versionsort` +: Natural sort of (version) numbers within text + +`--blocks <blocks>...` +: Specify the blocks that will be displayed and in what order [possible values: permission, user, group, size, date, name, inode] + +`--color <color>...` +: When to use terminal colours [default: auto] [possible values: always, auto, never] + +`--date <date>...` +: How to display date [possible values: date, relative, +date-time-format] [default: date] + +`--depth <num>...` +: Stop recursing into directories after reaching specified depth + +`--group-dirs <group-dirs>...` +: Sort the directories then the files [default: none] [possible values: none, first, last] + +`--icon <icon>...` +: When to print the icons [default: auto] [possible values: always, auto, never] + +`--icon-theme <icon-theme>...` +: Whether to use fancy or unicode icons [default: fancy] [possible values: fancy, unicode] + +`-I, --ignore-glob <pattern>...` +: Do not display files/directories with names matching the glob pattern(s). More than one can be specified by repeating the argument [default: ] + +`--size <size>...` +: How to display size [default: default] [possible values: default, short, bytes] + +`--sort <WORD>...` +: Sort by WORD instead of name [possible values: size, time, version, extension] + +# ARGS + +`<FILE>...` +: A file or directory to list [default: .] + +# EXAMPLES + +`lsd` +: Display listing for current directory + +`lsd /etc` +: Display listing of /etc + +`lsd -la` +: Display listing of current directory, including files starting with `.` and the current directory's entry. + +# ENVIRONMENT + +`LS_COLORS` +: Used to determine color for displaying filenames. See **dir_colors**. + +`XDG_CONFIG_HOME` +: Used to locate optional config file. If `XDG_CONFIG_HOME` is set, use `$XDG_CONFIG_HOME/lsd/config.yaml` else `$HOME/.config/lsd/config.yaml`. + |