From 235c968f9ad156b5c4da115a85f4280a13bd3ed3 Mon Sep 17 00:00:00 2001 From: Bob Polis Date: Mon, 22 Jul 2024 09:42:12 +0200 Subject: [PATCH] Add examples to man page --- tagger.1 | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/tagger.1 b/tagger.1 index b472a7e..e7d375a 100644 --- a/tagger.1 +++ b/tagger.1 @@ -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