about summary refs log tree commit diff stats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/quotify.1.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/quotify.1.md b/docs/quotify.1.md
new file mode 100644
index 0000000..546b559
--- /dev/null
+++ b/docs/quotify.1.md
@@ -0,0 +1,57 @@
+<!--
+Copyright (C) 2024 Benedikt Peetz <benedikt.peetz@b-peetz.de>
+SPDX-License-Identifier: AGPL-3.0-or-later
+
+This file is part of Quotify - A simple CLI utility to shell quote the text
+inputted into it.
+
+You should have received a copy of the License along with this program.
+If not, see <https://www.gnu.org/licenses/agpl.txt>.
+-->
+
+% QUOTIFY(1) quotify 0.1.0
+% Benedikt Peetz
+% Oct 2024
+
+# NAME
+
+quotify - A simple cli utility to shell quote the text inputed into it
+
+# SYNOPSIS
+
+**quotify** \[*--help*|*--version*\]
+
+# DESCRIPTION
+
+TODO
+
+# OPTIONS
+
+**--help**, **-h**
+: Displays a help message and exit.
+
+**--version**, **-v**
+: Displays the software version and exit.
+
+# EXAMPLES
+
+**quotify**
+: TODO. See the Description section for further details.
+
+# FILES
+
+*name.file*
+: This file is important because it does x.
+
+# BUGS
+
+Report bugs to <mailto://soispha@vhack.eu>.
+
+# COPYRIGHT
+
+Copyright (C) 2024  Benedikt Peetz
+
+This program is free software.
+
+You should have received a copy of the License
+along with this program.  If not, see <https://www.gnu.org/licenses/agpl.txt>.