From: Kevin Day <thekevinday@gmail.com>
Date: Sun, 8 Jan 2023 01:32:03 +0000 (-0600)
Subject: Update: Add man page documentation for iki_write.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=58abc286945935aa19dccf6f4b4d8d77d37709e6;p=fll

Update: Add man page documentation for iki_write.
---

diff --git a/level_3/iki_write/data/build/settings b/level_3/iki_write/data/build/settings
index da5f754..7cb04b6 100644
--- a/level_3/iki_write/data/build/settings
+++ b/level_3/iki_write/data/build/settings
@@ -27,6 +27,8 @@ build_sources_program main/main.c
 
 build_sources_headers main/iki_write.h main/common.h main/common-print.h main/print.h
 
+build_sources_documentation man
+
 build_script yes
 build_shared yes
 build_static no
diff --git a/level_3/iki_write/data/documentation/man/man1/iki_write.1 b/level_3/iki_write/data/documentation/man/man1/iki_write.1
new file mode 100644
index 0000000..ad53202
--- /dev/null
+++ b/level_3/iki_write/data/documentation/man/man1/iki_write.1
@@ -0,0 +1,73 @@
+.TH IKI_WRITE "1" "January 2023" "FLL - IKI Write 0.7.0" "User Commands"
+.SH NAME
+iki_write \- Convert text into an IKI format.
+.SH SYNOPSIS
+.B iki_write
+[\fI\,OPTIONS\/\fR]
+.SH DESCRIPTION
+.PP
+This program will accept \fBObject\fR and \fBContent\fR strings to generate an IKI string, such as \fBobject:"content"\fR.
+Each \fBObject\fR must have a \fBContent\fR (and each \fBContent\fR must have an \fBObject\fR).
+
+The \fBObject\fR is also called the \fBVocabulary\fR.
+A complete \fBObject\fR and \fBContent\fR set is also called a \fBVariable\fR.
+
+When piping main to this program, a single form-feed character (\fB\\f\fR) (\fBU+000C\fR) must be used to separate each \fBObject\fR from each \fBContent\fR.
+Furthermore, each \fBObject\fR must be followed by a \fBContent\fR.
+.SH OPTIONS
+.TP
+\fB\{+h, ++help\fR
+Print the help message.
+.TP
+\fB+d, ++dark\fR
+Output using colors that show up better on dark backgrounds
+.TP
+\fB+l, ++light\fR
+Output using colors that show up better on light backgrounds.
+.TP
+\fB+n, ++no_color\fR
+Do not print using color.
+.TP
+\fB+Q, ++quiet\fR
+Decrease verbosity, silencing most output.
+.TP
+\fB+E, ++error\fR
+Decrease verbosity, using only error output.
+.TP
+\fB+N, ++normal\fR
+Set verbosity to normal.
+.TP
+\fB+V, ++verbose\fR
+Increase verbosity beyond normal output.
+.TP
+\fB+D, ++debug\fR
+Enable debugging, significantly increasing verbosity beyond normal output.
+.TP
+\fB+v, ++version\fR
+Print only the version number.
+.TP
+\fB+F, ++line_first_no\fR
+Disable printing of first line.
+.TP
+\fB+L, ++line_last_no\fR
+Disable printing of last line.
+.TP
+\fB\-c, \-\-content\fR
+The Content to write.
+.TP
+\fB\-d, \-\-double\fR
+Use double quotes (default).
+.TP
+\fB\-f, \-\-file\fR
+Specify a file to send data to.
+.TP
+\fB\-o, \-\-object\fR
+The Object to write.
+.TP
+\fB\-s, \-\-single\fR
+Use single quotes.
+.SH AUTHOR
+Written by Kevin Day.
+.SH COPYRIGHT
+.PP
+Copyright \(co 2023 Kevin Day, GNU LGPL Version 2.1 or later.