Improve man page (#803)

Wordings & argument format
This commit is contained in:
Janek
2021-11-24 21:47:22 +01:00
committed by GitHub
parent 8fb8927fea
commit 10d362eab4

View File

@@ -8,13 +8,13 @@ topgrade \- upgrade everything
topgrade [\fIoptions\f[]] topgrade [\fIoptions\f[]]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
Keeping your system up to date mostly involves invoking more than a single package manager. Keeping your system up to date usually involves invoking multiple package managers.
This usually results in big shell one-liners saved in your shell history. This results in big, non-portable shell one-liners saved in your shell.
\fBtopgrade\fR tries to solve this problem by detecting which tools you use and run their appropriate package managers. To remedy this, \fBtopgrade\fR detects which tools you use and runs the appropriate commands to update them.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-\-only <only> .B \-\-only <only>
Run specific steps Run only specific steps
.RS .RS
.RE .RE
.TP .TP
@@ -29,7 +29,7 @@ Cleanup temporary or old files
.RE .RE
.TP .TP
.B \-n, \-\-dry\-run .B \-n, \-\-dry\-run
Outputs steps simulation List the commands that would be run
.RS .RS
.RE .RE
.TP .TP
@@ -39,7 +39,7 @@ Edit the configuration file
.RE .RE
.TP .TP
.B \-h, \-\-help .B \-h, \-\-help
Prints help information Print help information
.RS .RS
.RE .RE
.TP .TP
@@ -59,7 +59,7 @@ Run inside tmux
.RE .RE
.TP .TP
.B \-V, \-\-version .B \-V, \-\-version
Prints version information Print version information
.RS .RS
.RE .RE
.TP .TP
@@ -68,7 +68,10 @@ Output logs
.RS .RS
.RE .RE
.B \-y, \-\-yes .B \-y, \-\-yes
Say yes to package manager's prompt (experimental) Skip package manager's prompts (experimental)
.SH ARGUMENT FORMAT
Options can be given in any order.
A list of steps must be provided as a list of separate arguments, i.e. 'topgrade --only system shell'.
.SH BUGS .SH BUGS
For a list of bugs see <\fIhttps://github.com/r-darwish/topgrade/issues\fR>. For a list of bugs see <\fIhttps://github.com/r-darwish/topgrade/issues\fR>.
.SH AUTHOR .SH AUTHOR