diff options
| author | Teddy Wing | 2022-03-27 01:45:28 +0100 |
|---|---|---|
| committer | Teddy Wing | 2022-03-27 01:45:28 +0100 |
| commit | eb0fece027548e605f9d817eaddb5a8845b97cf8 (patch) | |
| tree | ff831e3f5411855211a2e0886cebc91af5937736 | |
| parent | 85eca61a34687636386939a0870de385911d7c20 (diff) | |
| download | yaqlite-eb0fece027548e605f9d817eaddb5a8845b97cf8.tar.bz2 | |
yaqlite.1.txt: Add command descriptions
| -rw-r--r-- | doc/yaqlite.1.txt | 9 | ||||
| -rw-r--r-- | share/man/man1/yaqlite.1 | 8 |
2 files changed, 12 insertions, 5 deletions
diff --git a/doc/yaqlite.1.txt b/doc/yaqlite.1.txt index 2b6ce80..e5ec47e 100644 --- a/doc/yaqlite.1.txt +++ b/doc/yaqlite.1.txt @@ -11,7 +11,8 @@ SYNOPSIS DESCRIPTION ----------- -TODO +A bridge between YAML and SQLite. Enables inserting YAML records into a +database and selecting records as YAML. OPTIONS ------- @@ -38,6 +39,9 @@ Insert Synopsis Insert Description ~~~~~~~~~~~~~~~~~~ +Insert a YAML-formatted record into <table-name>. The YAML is read from +<input-file> if specified. If <input-file> is "-" or empty, YAML is read from +standard input. Insert Options ~~~~~~~~~~~~~~ @@ -46,7 +50,6 @@ Insert Options SELECT COMMAND -------------- -TODO Select Synopsis ~~~~~~~~~~~~~~~ @@ -54,6 +57,8 @@ Select Synopsis Select Description ~~~~~~~~~~~~~~~~~~ +Select a record by <record-id> from <table-name>. The record will output in +YAML format to standard output. Select Options ~~~~~~~~~~~~~~ diff --git a/share/man/man1/yaqlite.1 b/share/man/man1/yaqlite.1 index 06a5162..ecaa8be 100644 --- a/share/man/man1/yaqlite.1 +++ b/share/man/man1/yaqlite.1 @@ -34,7 +34,7 @@ yaqlite \- YAML interface for SQLite \fIyaqlite\fR [\-\-help] [\-\-version] <command> [<args>] .SH "DESCRIPTION" .sp -TODO +A bridge between YAML and SQLite\&. Enables inserting YAML records into a database and selecting records as YAML\&. .SH "OPTIONS" .PP \-h, \-\-help @@ -62,6 +62,8 @@ Select a record as YAML\&. .sp \fIyaqlite insert\fR [<options>] <table\-name> [<input\-file>] .SS "Insert Description" +.sp +Insert a YAML\-formatted record into <table\-name>\&. The YAML is read from <input\-file> if specified\&. If <input\-file> is "\-" or empty, YAML is read from standard input\&. .SS "Insert Options" .PP \-\-database @@ -69,12 +71,12 @@ Select a record as YAML\&. 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" +.sp +Select a record by <record\-id> from <table\-name>\&. The record will output in YAML format to standard output\&. .SS "Select Options" .PP \-\-database |