summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorCanop <cano.petrole@gmail.com>2023-07-15 22:49:24 +0200
committerCanop <cano.petrole@gmail.com>2023-07-15 22:49:24 +0200
commitb8005c8d11cae0206f99d5b62237bd70effa41b8 (patch)
treeae8722d38e4e6db63f9c398de14ca4e8cfe701f6 /man
parent0edc0fc30ae49c39334f783a6b41852ef272c6f0 (diff)
updated man page
Diffstat (limited to 'man')
-rw-r--r--man/page148
1 files changed, 99 insertions, 49 deletions
diff --git a/man/page b/man/page
index 33933eb..71e7933 100644
--- a/man/page
+++ b/man/page
@@ -22,84 +22,134 @@ Flags and options can be classically passed on launch but also written in the co
.SH FLAGS
FLAGS
.TP
-.B \-d ", " \-\-dates
+\fB\-d\fR, \fB\-\-dates\fR
Show the last modified date of files and directories
.TP
-.B \-D ", " \-\-no-dates
-Don't show the last modified date
+\fB\-D\fR, \fB\-\-no\-dates\fR
+Don\*(Aqt show the last modified date
.TP
-.B \-f ", " \-\-only-folders
+\fB\-f\fR, \fB\-\-only\-folders\fR
Only show folders
.TP
-.B \-F ", " \-\-no-only-folders
+\fB\-F\fR, \fB\-\-no\-only\-folders\fR
Show folders and files alike
.TP
-.B \-g ", " \-\-show-git-info
-Show git statuses on files and stats of repository
+\fB\-\-show\-root\-fs\fR
+Show filesystem info on top
.TP
-.B \-G ", " \-\-no-show-git-info
-Don't show git statuses on files nor stats
+\fB\-g\fR, \fB\-\-show\-git\-info\fR
+Show git statuses on files and stats on repo
.TP
-.B \-h ", " \-\-hidden
+\fB\-G\fR, \fB\-\-no\-show\-git\-info\fR
+Don\*(Aqt show git statuses on files and stats on repo
+.TP
+\fB\-\-git\-status\fR
+Only show files having an interesting git status, including hidden ones
+.TP
+\fB\-\-help\fR
+Print help information
+.TP
+\fB\-h\fR, \fB\-\-hidden\fR
Show hidden files
.TP
-.B \-H ", " \-\-no-hidden
-Don't show hidden files
+\fB\-H\fR, \fB\-\-no\-hidden\fR
+Don\*(Aqt show hidden files
+.TP
+\fB\-i\fR, \fB\-\-git\-ignored\fR
+Show git ignored files
+.TP
+\fB\-I\fR, \fB\-\-no\-git\-ignored\fR
+Don\*(Aqt show git ignored files
+.TP
+\fB\-p\fR, \fB\-\-permissions\fR
+Show permissions
+.TP
+\fB\-P\fR, \fB\-\-no\-permissions\fR
+Don\*(Aqt show permissions
+.TP
+\fB\-s\fR, \fB\-\-sizes\fR
+Show the size of files and directories
+.TP
+\fB\-S\fR, \fB\-\-no\-sizes\fR
+Don\*(Aqt show sizes
+.TP
+\fB\-\-sort\-by\-count\fR
+Sort by count (only show one level of the tree)
+.TP
+\fB\-\-sort\-by\-date\fR
+Sort by date (only show one level of the tree)
.TP
-.B \-i ", " \-\-show-gitignored
-Show files which should be ignored according to git
+\fB\-\-sort\-by\-size\fR
+Sort by size (only show one level of the tree)
.TP
-.B \-I ", " \-\-no-show-gitignored
-Don't show gitignored files
+\fB\-\-sort\-by\-type\fR
+Same as sort\-by\-type\-dirs\-first
.TP
-.B \-p ", " \-\-permissions
-Show permissions with owner and group
+\fB\-\-sort\-by\-type\-dirs\-first\fR
+Sort by type, directories first (only show one level of the tree)
.TP
-.B \-P ", " \-\-no-permissions
-Don't show permissions
+\fB\-\-sort\-by\-type\-dirs\-last\fR
+Sort by type, directories last (only show one level of the tree)
.TP
-.B \-s ", " \-\-sizes
-Show the sizes of files and directories. When this mode is on, children aren't shown so that the biggest entries at the selected level can be sorted first.
+\fB\-w\fR, \fB\-\-whale\-spotting\fR
+Sort by size, show ignored and hidden files
.TP
-.B \-S ", " \-\-no-sizes
-Don't show sizes
+\fB\-\-no\-sort\fR
+Don\*(Aqt sort
.TP
-.B \-t ", " \-\-trim-root
-Trim the root: remove elements which would exceed the screen size. This removes the scrollbar.
+\fB\-t\fR, \fB\-\-trim\-root\fR
+Trim the root too and don\*(Aqt show a scrollbar
.TP
-.B \-T ", " \-\-no-trim-root
-Don't trim the root (still trim the deeper levels). A scrollbar may be used when there are too many elements to show on screen.
+\fB\-T\fR, \fB\-\-no\-trim\-root\fR
+Don\*(Aqt trim the root level, show a scrollbar
.TP
-.B \-\-install
-Install or reinstall the \fBbr\fR shell function
+\fB\-\-outcmd\fR=\fIOUTCMD\fR
+Where to write the produced cmd (if any)
.TP
-.B \-\-color <yes|no|auto>
-Controls styling of the output (default: auto). If set to auto, all styling is removed when output is piped.
+\fB\-c\fR, \fB\-\-cmd\fR=\fICMD\fR
+Semicolon separated commands to execute
.TP
-.B \-\-help
-Prints a help page, with more or less the same content as this man page
+\fB\-\-color\fR=\fICOLOR\fR [default: auto]
+Whether to have styles and colors (default is usually OK)
+.br
+
+.br
+[\fIpossible values: \fRauto, yes, no]
+.TP
+\fB\-\-conf\fR=\fICONF\fR
+Semicolon separated paths to specific config files
+.TP
+\fB\-\-height\fR=\fIHEIGHT\fR
+Height (if you don\*(Aqt want to fill the screen or for file export)
+.TP
+\fB\-\-install\fR
+Install or reinstall the br shell function
+.TP
+\fB\-\-set\-install\-state\fR=\fISET_INSTALL_STATE\fR
+Where to write the produced cmd (if any)
+.br
+
+.br
+[\fIpossible values: \fRundefined, refused, installed]
.TP
-.B \-v ", " \-\-version
-Prints the version of \fBbroot\fR
-.SH PARAMETERS:
+\fB\-\-print\-shell\-function\fR=\fIPRINT_SHELL_FUNCTION\fR
+Print to stdout the br function for a given shell
.TP
-.B \-\-outcmd <cmd-export-path>
-Where to write a command if broot produces one
+\fB\-\-listen\fR=\fILISTEN\fR
+A socket to listen to for commands
.TP
-.B \-c ", " \-\-cmd <commands>
-Semicolon separated commands to execute on start of \fBbroot\fR
+\fB\-\-get\-root\fR
+Ask for the current root of the remote broot
.TP
-.B \-\-height <height>
-Height to use if you don't want to fill the screen or for file export (by default the terminal height is used)
+\fB\-\-write\-default\-conf\fR=\fIWRITE_DEFAULT_CONF\fR
+Write default conf files in given directory
.TP
-.B \-o ", " \-\-out <file-export-path>
-Where to write the produced path, if any
+\fB\-\-send\fR=\fISEND\fR
+A socket that broot sends commands to before quitting
.TP
-.B \-\-set-install-state <undefined|refused|installed>
-Set the installation state. This is mostly useful in installation scripts to override the normal installation process.
+\fB\-V\fR, \fB\-\-version\fR
+Print version
.TP
-.B \-\-print-shell-function <bash|fish|zsh>
-Print to stdout the \fBbr\fR function for the given shell. This can be used in your own installation process overridden the standard one.
.SH BUGS
.PP
.B broot