aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2022-03-23 00:40:17 +0100
committerTeddy Wing2022-03-23 00:40:17 +0100
commitd81ed362f2c3dde4727872407f5a1b229073277b (patch)
tree728d3bf445fca2590c6157b5be9947778553c9fa
parent2313a1bd0910e7b42cc23f83d6722272b87e0baf (diff)
downloadyaqlite-d81ed362f2c3dde4727872407f5a1b229073277b.tar.bz2
Start writing man page
-rw-r--r--Makefile13
-rw-r--r--doc/yaqlite.1.txt30
-rw-r--r--share/man/man1/yaqlite.149
3 files changed, 92 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..c80ab49
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,13 @@
+MAN_PAGE := doc/yaqlite.1.txt
+MAN_DIR := share/man/man1
+MAN_PRODUCT := $(MAN_DIR)/yaqlite.1
+
+
+.PHONY: doc
+doc: $(MAN_PRODUCT)
+
+$(MAN_PRODUCT): $(MAN_PAGE) | $(MAN_DIR)
+ a2x --destination-dir $(MAN_DIR) --no-xmllint --format manpage $<
+
+$(MAN_DIR):
+ mkdir -p $@
diff --git a/doc/yaqlite.1.txt b/doc/yaqlite.1.txt
new file mode 100644
index 0000000..026fc16
--- /dev/null
+++ b/doc/yaqlite.1.txt
@@ -0,0 +1,30 @@
+yaqlite(1)
+==========
+
+NAME
+----
+yaqlite - YAML interface for SQLite
+
+SYNOPSIS
+--------
+'yaqlite' [--help] [--version] <command> [<args>]
+
+DESCRIPTION
+-----------
+TODO
+
+OPTIONS
+-------
+TODO
+
+COMMANDS
+--------
+TODO
+
+INSERT COMMAND
+--------------
+TODO
+
+SELECT COMMAND
+--------------
+TODO
diff --git a/share/man/man1/yaqlite.1 b/share/man/man1/yaqlite.1
new file mode 100644
index 0000000..2d9dffe
--- /dev/null
+++ b/share/man/man1/yaqlite.1
@@ -0,0 +1,49 @@
+'\" t
+.\" Title: yaqlite
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 03/23/2022
+.\" Manual: \ \&
+.\" Source: \ \&
+.\" Language: English
+.\"
+.TH "YAQLITE" "1" "03/23/2022" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+yaqlite \- YAML interface for SQLite
+.SH "SYNOPSIS"
+.sp
+\fIyaqlite\fR [\-\-help] [\-\-version] <command> [<args>]
+.SH "DESCRIPTION"
+.sp
+TODO
+.SH "OPTIONS"
+.sp
+TODO
+.SH "COMMANDS"
+.sp
+TODO
+.SH "INSERT COMMAND"
+.sp
+TODO
+.SH "SELECT COMMAND"
+.sp
+TODO