diff options
author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2024-04-02 14:26:11 +0200 |
---|---|---|
committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2024-04-02 14:26:11 +0200 |
commit | aabba688f54323f1cd4451ec068598152b67d9e0 (patch) | |
tree | b733baef48cd1b3bee997f73b6d5d181f4da1e84 /templates/shell/docs/%INIT_APPLICATION_NAME.1.md | |
parent | chore(common/treefmt.nix): Ignore the pre-generation markdown file (diff) | |
download | flake-templates-aabba688f54323f1cd4451ec068598152b67d9e0.tar.gz flake-templates-aabba688f54323f1cd4451ec068598152b67d9e0.zip |
chore(templates): Update common files
Diffstat (limited to 'templates/shell/docs/%INIT_APPLICATION_NAME.1.md')
-rw-r--r-- | templates/shell/docs/%INIT_APPLICATION_NAME.1.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/templates/shell/docs/%INIT_APPLICATION_NAME.1.md b/templates/shell/docs/%INIT_APPLICATION_NAME.1.md new file mode 100644 index 0000000..0a7ec9d --- /dev/null +++ b/templates/shell/docs/%INIT_APPLICATION_NAME.1.md @@ -0,0 +1,54 @@ +% %INIT_APPLICATION_NAME_CAPITALIZED_MAN_PART %INIT_APPLICATION_NAME %INIT_APPLICATION_VERSION +% %INIT_AUTHOR_NAME +% %INIT_CURRENT_DATE + +# NAME + +%INIT_APPLICATION_NAME - %INIT_DESCRIPTION + +# SYNOPSIS + +**%INIT_APPLICATION_NAME** \[*--help*|*--version*\] + +# DESCRIPTION + +TODO + +# OPTIONS + +**--help**, **-h** +: Displays a help message and exit. + +**--version**, **-v** +: Displays the software version and exit. + +# EXAMPLES + +**%INIT_APPLICATION_NAME** +: TODO. See the Description section for further details. + +# FILES + +*name.file* +: This file is important because it does x. + +# BUGS + +Report bugs to <https://%INIT_REMOTE/%INIT_OWNER/%INIT_REPOSITORY/issues>. + +# COPYRIGHT + +Copyright (C) %INIT_YEAR %INIT_AUTOHR_NAME + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <https://www.gnu.org/licenses/>. |