commit fd7dabebe0ae11b609c96e3c2a25426663731f36
parent 737edf3ca2d92b956364a7ec00d4708dfdaffdd4
Author: nibo <nibo@relim.de>
Date: Thu, 19 Dec 2024 08:07:14 +0100
Improve man page
Diffstat:
| M | lorid.1 | | | 26 | ++++++++++++++++++++++++-- |
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/lorid.1 b/lorid.1
@@ -1,9 +1,9 @@
-.TH LORID "1" "September 2024" "User Commands"
+.TH LORID "1" "December 2024" "User Commands"
.SH NAME
lorid \- convert chordpro to pdf
.SH SYNOPSIS
.B lorid
-[-p] [-c] [-v] [-h] [-o \fI\,path\/\fR] [\fI\,filepath\/\fR]
+[-p] [-c \fI\,filepath\/\fR] [-v] [-h] [-o \fI\,path\/\fR] [\fI\,filepath\/\fR] ...
.SH DESCRIPTION
.PP
.B lorid
@@ -13,6 +13,28 @@ and if it wasn't provided then from stdin.
The text will be parsed according to the chordpro specification
and then converted to pdf. These two steps can be altered by
changing the configuration file.
+.TP
+\fB\,-o\/\fR, \fB\,--output\/\fR
+Specify an output folder or file. If you specify a folder
+then the generated pdf file will be saved in that folder.
+If you specify a file the generated pdf file will be saved
+as that file.
+.TP
+\fB\,-p\/\fR, \fB\,--print-default-config\/\fR
+Print the default configuration as TOML.
+.TP
+\fB\,-c\/\fR, \fB\,--config\/\fR \fI\,FILE\/\fR
+Specify a configuration file.
+
+By default the file
+.B ~/.config/lorid/config.toml
+will be used as the configuration file.
+.TP
+\fB\,-v\/\fR, \fB\,--version\/\fR
+Print the program version.
+.TP
+\fB\,-h\/\fR, \fB\,--help\/\fR
+Print a short message to help use the program.
.SH CHORDPRO
.PP
You can find the chordpro specification at https://www.chordpro.org/chordpro/.