aboutsummaryrefslogtreecommitdiff
path: root/docs/finbudg.1.scd
diff options
context:
space:
mode:
Diffstat (limited to 'docs/finbudg.1.scd')
-rw-r--r--docs/finbudg.1.scd40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/finbudg.1.scd b/docs/finbudg.1.scd
new file mode 100644
index 0000000..8e3f7e3
--- /dev/null
+++ b/docs/finbudg.1.scd
@@ -0,0 +1,40 @@
+finbudg(1)
+
+# NAME
+
+finbudg - Quick cli tool to calculate your expenses and balance for a set period
+of time.
+
+# SYNOPSIS
+
+*finbudg* [FLAGS] <_file_>
+
+# DESCRIPTION
+
+This program helps you calculate your expenses and balance by providing it with
+a file containing a list of expenses made for a specified period of time. See
+*finbudg*(5) for more information on the syntax of this file.
+
+# FLAGS
+
+*-h, --help *
+ Prints the list of flags available.
+
+*-p, --plain*
+ Don't colorize the output. Can also be set with the *NO_COLOR* environment
+ variable.
+
+*--force-color*
+ Forces colorized output even when piping. Takes precedence over *--plain*
+ flag and *NO_COLOR* environment variable.
+
+*-V, --version*
+ Prints version information and exits.
+
+# SEE ALSO
+
+*finbudg*(5)
+
+# AUTHORS
+
+Yaroslav de la Peña Smirnov <yps@yaroslavps.com>.