From 8d6e633a59df2df3d0784d8326e1ccd268a65a9e Mon Sep 17 00:00:00 2001 From: holly sparkles Date: Fri, 22 Dec 2023 22:43:28 +0100 Subject: [PATCH] docs: add pandoc man page template --- doc/man/gmss.1.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 doc/man/gmss.1.md diff --git a/doc/man/gmss.1.md b/doc/man/gmss.1.md new file mode 100644 index 0000000..64ca770 --- /dev/null +++ b/doc/man/gmss.1.md @@ -0,0 +1,85 @@ +% GMSS(1) version 0.1.0 | User Commands +% +% 22 December 2023 + +NAME +==== + +gmss - gimme my screenshot! + +SYNOPSIS +======== + +| **gmss** **\--out** _location_ + +DESCRIPTION +=========== + +A screenshot utility. Nothing else. + +OPTIONS +======= + +**-o** _location_, **\--out** _location_ + +: The output directory or file path to write to. + + If a directory is specified, a filename will be generated based on the current date and time. + (Required) + + Example: + + : **\--out** _$HOME/screenshots/my_screenshot.png_ + + **\--out** _/$HOME/screenshots_ + +FILENAME TIMESTAMPS +=================== + +gmss has support for formatting timestamps in filenames. + +The default filename format is +``` +screenshot-%Y-%m-%d_%H-%M-%S.png +``` + +- `%Y`: Year with century as a decimal number (e.g., 2022) +- `%m`: Month as a zero-padded decimal number (01 to 12) +- `%B`: Full month name (e.g., January) +- `%b`: Abbreviated month name (e.g., Jan) +- `%d`: Day of the month as a zero-padded decimal number (01 to 31) +- `%e`: Day of the month as a decimal number (1 to 31) +- `%A`: Full weekday name (e.g., Monday) +- `%a`: Abbreviated weekday name (e.g., Mon) +- `%H`: Hour (00 to 23) +- `%I`: Hour (01 to 12) +- `%M`: Minute (00 to 59) +- `%S`: Second (00 to 59) +- `%p`: AM or PM designation +- `%f`: Subsecond (in nanoseconds) +- `%F`: ISO 8601 date format (YYYY-MM-DD) +- `%c`: Date and time representation appropriate for locale +- `%r`: 12-hour clock time (e.g., 08:30:45 PM) +- `%Z`: Time zone offset (+0900) +- `%z`: Time zone offset (+09:00) +- `%U`: Week number of the year (Sunday as the first day of the week) (00 to 53) +- `%W`: Week number of the year (Monday as the first day of the week) (00 to 53) +- `%j`: Day of the year (001 to 366) +- `%x`: Date representation for the current locale +- `%X`: Time representation for the current locale +- `%%`: Percent sign + +BUGS +==== + +Bugs can be submitted via e-mail. + +AUTHORS +======= + +holly sparkles \ + +REPOSITORY +========== + +https://git.holly.sh/gmss.git \ No newline at end of file -- libgit2 1.7.2