diff options
author | Teddy Wing | 2022-03-27 01:12:46 +0100 |
---|---|---|
committer | Teddy Wing | 2022-03-27 01:12:46 +0100 |
commit | 85eca61a34687636386939a0870de385911d7c20 (patch) | |
tree | 02973f74e34d1f396f9ea2650b6193cca4509f6a | |
parent | f8783d6edcb97348491a5791bfb5011987ecb2a7 (diff) | |
download | yaqlite-85eca61a34687636386939a0870de385911d7c20.tar.bz2 |
yaqlite.1.txt: Describe subcommand options
-rw-r--r-- | doc/yaqlite.1.txt | 37 | ||||
-rw-r--r-- | share/man/man1/yaqlite.1 | 39 |
2 files changed, 72 insertions, 4 deletions
diff --git a/doc/yaqlite.1.txt b/doc/yaqlite.1.txt index b82014d..2b6ce80 100644 --- a/doc/yaqlite.1.txt +++ b/doc/yaqlite.1.txt @@ -31,8 +31,43 @@ COMMANDS INSERT COMMAND -------------- -TODO + +Insert Synopsis +~~~~~~~~~~~~~~~ +'yaqlite insert' [<options>] <table-name> [<input-file>] + +Insert Description +~~~~~~~~~~~~~~~~~~ + +Insert Options +~~~~~~~~~~~~~~ +--database:: + The database to insert into. SELECT COMMAND -------------- TODO + +Select Synopsis +~~~~~~~~~~~~~~~ +'yaqlite select' [<options>] <table-name> <record-id> + +Select Description +~~~~~~~~~~~~~~~~~~ + +Select Options +~~~~~~~~~~~~~~ +--database:: + The database to select from. + +--exclude-column:: + Exclude the given column from the YAML output. This option can be given + multiple times to exclude several columns. + +--include-primary-key:: + Include the primary key field in the YAML output. By default, the primary + key is excluded. + +--primary_key:: + Name of the column to that matches <record-id>. Defaults to the table's + primary key. diff --git a/share/man/man1/yaqlite.1 b/share/man/man1/yaqlite.1 index 19afc5c..06a5162 100644 --- a/share/man/man1/yaqlite.1 +++ b/share/man/man1/yaqlite.1 @@ -2,12 +2,12 @@ .\" 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/25/2022 +.\" Date: 03/27/2022 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "YAQLITE" "1" "03/25/2022" "\ \&" "\ \&" +.TH "YAQLITE" "1" "03/27/2022" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -58,8 +58,41 @@ Insert a record from YAML\&. Select a record as YAML\&. .RE .SH "INSERT COMMAND" +.SS "Insert Synopsis" .sp -TODO +\fIyaqlite insert\fR [<options>] <table\-name> [<input\-file>] +.SS "Insert Description" +.SS "Insert Options" +.PP +\-\-database +.RS 4 +The database to insert into\&. +.RE .SH "SELECT COMMAND" .sp TODO +.SS "Select Synopsis" +.sp +\fIyaqlite select\fR [<options>] <table\-name> <record\-id> +.SS "Select Description" +.SS "Select Options" +.PP +\-\-database +.RS 4 +The database to select from\&. +.RE +.PP +\-\-exclude\-column +.RS 4 +Exclude the given column from the YAML output\&. This option can be given multiple times to exclude several columns\&. +.RE +.PP +\-\-include\-primary\-key +.RS 4 +Include the primary key field in the YAML output\&. By default, the primary key is excluded\&. +.RE +.PP +\-\-primary_key +.RS 4 +Name of the column to that matches <record\-id>\&. Defaults to the table\(cqs primary key\&. +.RE |