summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefano Facchini <stefano.facchini@gmail.com>2020-06-20 10:56:08 +0200
committerStefano Facchini <stefano.facchini@gmail.com>2020-06-20 11:02:29 +0200
commit1a2bc9165f91c44a77e73bc5961f658e9cda5a53 (patch)
tree4e84fe956e7e39e74f0fa4e7274a98734ec51764
parent73d17de77e82cee50c4889fc01ea2d5792c64c43 (diff)
downloadbaobab-1a2bc9165f91c44a77e73bc5961f658e9cda5a53.tar.gz
Update man page
-rw-r--r--data/baobab.1172
1 files changed, 30 insertions, 142 deletions
diff --git a/data/baobab.1 b/data/baobab.1
index 321c0a1..3bb7aac 100644
--- a/data/baobab.1
+++ b/data/baobab.1
@@ -1,149 +1,37 @@
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
-.nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
-.fi
-..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
-. ds C` ""
-. ds C' ""
-'br\}
-.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
-'br\}
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
-.\" entries marked with X<> in POD. Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.if \nF \{\
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
-..
-. nr % 0
-. rr F
-.\}
-.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
.IX Title "BAOBAB 1"
-.TH BAOBAB 1
+
+.TH BAOBAB 1 "June 2020"
+
.SH "NAME"
-\&\fBBaobab\fR \- A graphical tool to analyze disk usage
+\fBbaobab\fR \- A graphical disk usage analyzer for the GNOME desktop
+
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
-\&\fBbaobab\fR [directory]
+\fBbaobab\fR [OPTIONS…] [DIRECTORY]
+
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-\&\fBbaobab\fR is able to scan either specific folders (local and remote)
-or devices, in order to give the user a tree representation including
-each directory size or percentage in the branch. It also auto-detects any
-mounted/unmounted device. A graphical representation is also provided for
-any selected folder.
+\fBbaobab\fR (a.k.a. \fBDisk Usage Analyzer\fR) is able to scan either specific
+folders (local and remote) or devices, in order to give the user a tree
+representation including each directory size or percentage in the branch. It
+also auto-detects any mounted/unmounted device. A graphical representation is
+also provided for any selected folder.
.PP
-A detailed documentation on the program could be read at:
-https://wiki.gnome.org/Apps/Baobab
-.SH "AUTHOR"
-.IX Header "AUTHOR"
-Fabio \s-1MARZOCCA\s0 <thesaltydog@gmail.com>
+
+.SH "OPTIONS"
+
+.TP
+\fB\-x\fR, \fB\-\-one\-file\-system\fR
+Skip directories on different file systems. Ignored if DIRECTORY is not specified.
+.TP
+\fB\-\-help\fR
+Show command line options.
+.TP
+\fB\-\-version\fR
+Output version information and exit.
+
+.SH "BUGS"
+Bugs should be reported to the GNOME issue tracker at \m[blue]\fBhttp://gitlab.gnome.org/GNOME/baobab/issues\fR\m[].
+
+.SH "ADDITIONAL INFORMATION"
+For further information visit \m[blue]\fBhttps://wiki.gnome.org/Apps/DiskUsageAnalyzer\fR\m[].