Add examples to man page

This commit is contained in:
Bob Polis 2024-07-22 09:42:12 +02:00
parent 7205bd7315
commit 235c968f9a

View File

@ -27,6 +27,11 @@ The
tool allows you to list and/or edit tags in bulk, with a convenient command line
interface.
.Pp
If you add, change, and delete tags from files and/or directories in a single
command,
.Nm
will first delete tags, then apply changes, and finally add tags, in that order.
.Pp
The options are as follows:
.Ss General Options
.Bl -tag -width Ds
@ -73,13 +78,26 @@ alphabetically sorted order.
.Sh ENVIRONMENT
.Nm
uses libscterm for its color output support, and as such honors the NO_COLOR
environment variable.
environment variable, if defined and non-empty.
Color output is also automatically suppressed when it is not written to a tty,
such as when writing to a pipe, or when using output redirection.
.Sh EXIT STATUS
.Nm
exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES
.Sh EXAMPLES
To change `Biografie' into `Biography' in all files in the current directory,
but only if present:
.Pp
.Dl tagger -c Biografie -i Biography *
.Pp
List the tags in a file named `MyMovie.mp4':
.Pp
.Dl tagger -l MyMovie.mp4
.Pp
To delete all `foo' and `bar' tags from files, if present:
.Pp
.Dl tagger -d foo -d bar *
.Pp
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.Sh SEE ALSO