]> git.ipfire.org Git - thirdparty/sqlite.git/commitdiff
Modernize the sqlite3 shell man page a bit, per [forum:d9aa201dee553bb2|forum request].
authorstephan <stephan@noemail.net>
Fri, 11 Aug 2023 22:40:06 +0000 (22:40 +0000)
committerstephan <stephan@noemail.net>
Fri, 11 Aug 2023 22:40:06 +0000 (22:40 +0000)
FossilOrigin-Name: 3bc0693c4633f545f09dbee702e25354504b20836373a068447e6c61cb2ebd79

manifest
manifest.uuid
sqlite3.1

index 151f12d02113e8cedda81969e93f865322d5f364..59726575cb085619902d82028de38c98c5a589c0 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C If\sSQLITE_USE_SEH\sis\sdefined,\shandle\sstructured-exceptions\sthrown\sby\sMSVC\sbuilds\sif\sthe\s*-shm\sfile\smapping\sis\saccessed\safter\sit\sbecomes\sinvalid\sfor\ssome\sreason.
-D 2023-08-11T19:31:51.656
+C Modernize\sthe\ssqlite3\sshell\sman\spage\sa\sbit,\sper\s[forum:d9aa201dee553bb2|forum\srequest].
+D 2023-08-11T22:40:06.541
 F .fossil-settings/empty-dirs dbb81e8fc0401ac46a1491ab34a7f2c7c0452f2f06b54ebb845d024ca8283ef1
 F .fossil-settings/ignore-glob 35175cdfcf539b2318cb04a9901442804be81cd677d8b889fcc9149c21f239ea
 F LICENSE.md df5091916dbb40e6e9686186587125e1b2ff51f022cc334e886c19a0e9982724
@@ -572,7 +572,7 @@ F mptest/mptest.c aa41ace6dbc5050d76b02548d3521e6bbccae4f0
 F mptest/multiwrite01.test dab5c5f8f9534971efce679152c5146da265222d
 F spec.template 86a4a43b99ebb3e75e6b9a735d5fd293a24e90ca
 F sqlite.pc.in 42b7bf0d02e08b9e77734a47798d1a55a9e0716b
-F sqlite3.1 fc7ad8990fc8409983309bb80de8c811a7506786
+F sqlite3.1 acdff36db796e2d00225b911d3047d580cd136547298435426ce9d40347973cc
 F sqlite3.pc.in 48fed132e7cb71ab676105d2a4dc77127d8c1f3a
 F sqlite_cfg.h.in baf2e409c63d4e7a765e17769b6ff17c5a82bbd9cbf1e284fd2e4cefaff3fcf2
 F src/alter.c 3ff8c2fca0c0636d43459154bb40d79c882df1b34df77f89c4ec47ab2e2389f5
@@ -2051,8 +2051,8 @@ F vsixtest/vsixtest.tcl 6a9a6ab600c25a91a7acc6293828957a386a8a93
 F vsixtest/vsixtest.vcxproj.data 2ed517e100c66dc455b492e1a33350c1b20fbcdc
 F vsixtest/vsixtest.vcxproj.filters 37e51ffedcdb064aad6ff33b6148725226cd608e
 F vsixtest/vsixtest_TemporaryKey.pfx e5b1b036facdb453873e7084e1cae9102ccc67a0
-P 0d7aac45b8e7078cc80757e12d6f0b2584f2b0b184dacc2348ad3519978e5bf9 3ed89c344fcb3b7ee8b764d95144643e42e053e1116150d6eda8355fbd6669df
-R 35781298e1f4461a1a53ad9bec2f5ba2
-U dan
-Z d4c9bf3d3544cd45d448f96b6769914e
+P 8a6b0c24937e855b710f97b4aea973eff53e6d43e1182842731547aa4b37db2a
+R 43c88f4a8c1b73283f31097d1c50c3b5
+U stephan
+Z 44f8c32555ee16d703264cb55479403e
 # Remove this line to create a well-formed Fossil manifest.
index fc40b98c6e02bf62eeb5436abafdfe1ba80a1dd8..1f635467da700aad376e9fbe2b0fb05fbb600a6c 100644 (file)
@@ -1 +1 @@
-8a6b0c24937e855b710f97b4aea973eff53e6d43e1182842731547aa4b37db2a
\ No newline at end of file
+3bc0693c4633f545f09dbee702e25354504b20836373a068447e6c61cb2ebd79
\ No newline at end of file
index 80353b0eecd9848204c711d6264ca116b2d1064b..08b1ff262b66c216b1e3efb473d0ace6df9cad7c 100644 (file)
--- a/sqlite3.1
+++ b/sqlite3.1
@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH SQLITE3 1 "Fri Oct 31 10:41:31 EDT 2014"
+.TH SQLITE3 1 "Fri Aug 11 23:50:12 CET 2023"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -49,9 +49,9 @@ a table named "memos" and insert a couple of records into that table:
 $ 
 .B sqlite3 mydata.db
 .br
-SQLite version 3.8.8
+SQLite version 3.43.0 2023-08-11 17:45:23
 .br
-Enter ".help" for instructions
+Enter ".help" for usage hints.
 .br
 sqlite>
 .B create table memos(text, priority INTEGER);
@@ -108,141 +108,13 @@ sqlite>
 .B .help
 .nf
 .tr %.
-%backup ?DB? FILE      Backup DB (default "main") to FILE
-%bail on|off           Stop after hitting an error.  Default OFF
-%clone NEWDB           Clone data into NEWDB from the existing database
-%databases             List names and files of attached databases
-%dump ?TABLE? ...      Dump the database in an SQL text format
-                         If TABLE specified, only dump tables matching
-                         LIKE pattern TABLE.
-%echo on|off           Turn command echo on or off
-%eqp on|off            Enable or disable automatic EXPLAIN QUERY PLAN
-%exit                  Exit this program
-%explain ?on|off?      Turn output mode suitable for EXPLAIN on or off.
-                         With no args, it turns EXPLAIN on.
-%fullschema            Show schema and the content of sqlite_stat tables
-%headers on|off        Turn display of headers on or off
-%help                  Show this message
-%import FILE TABLE     Import data from FILE into TABLE
-%indices ?TABLE?       Show names of all indices
-                         If TABLE specified, only show indices for tables
-                         matching LIKE pattern TABLE.
-%load FILE ?ENTRY?     Load an extension library
-%log FILE|off          Turn logging on or off.  FILE can be stderr/stdout
-%mode MODE ?TABLE?     Set output mode where MODE is one of:
-                         csv      Comma-separated values
-                         column   Left-aligned columns.  (See .width)
-                         html     HTML <table> code
-                         insert   SQL insert statements for TABLE
-                         line     One value per line
-                         list     Values delimited by .separator string
-                         tabs     Tab-separated values
-                         tcl      TCL list elements
-%nullvalue STRING      Use STRING in place of NULL values
-%once FILENAME         Output for the next SQL command only to FILENAME
-%open ?FILENAME?       Close existing database and reopen FILENAME
-%output ?FILENAME?     Send output to FILENAME or stdout
-%print STRING...       Print literal STRING
-%prompt MAIN CONTINUE  Replace the standard prompts
-%quit                  Exit this program
-%read FILENAME         Execute SQL in FILENAME
-%restore ?DB? FILE     Restore content of DB (default "main") from FILE
-%save FILE             Write in-memory database into FILE
-%schema ?TABLE?        Show the CREATE statements
-                         If TABLE specified, only show tables matching
-                         LIKE pattern TABLE.
-%separator STRING ?NL? Change separator used by output mode and .import
-                         NL is the end-of-line mark for CSV
-%shell CMD ARGS...     Run CMD ARGS... in a system shell
-%show                  Show the current values for various settings
-%stats on|off          Turn stats on or off
-%system CMD ARGS...    Run CMD ARGS... in a system shell
-%tables ?TABLE?        List names of tables
-                         If TABLE specified, only list tables matching
-                         LIKE pattern TABLE.
-%timeout MS            Try opening locked tables for MS milliseconds
-%timer on|off          Turn SQL timer on or off
-%trace FILE|off        Output each SQL statement as it is run
-%vfsname ?AUX?         Print the name of the VFS stack
-%width NUM1 NUM2 ...   Set column widths for "column" mode
-                         Negative values right-justify
-sqlite>
+...
 .sp
 .fi
-.SH OPTIONS
-.B sqlite3
-has the following options:
-.TP
-.B \-bail
-Stop after hitting an error.
-.TP
-.B \-batch
-Force batch I/O.
-.TP
-.B \-column
-Query results will be displayed in a table like form, using
-whitespace characters to separate the columns and align the
-output.
-.TP
-.BI \-cmd\  command
-run
-.I command
-before reading stdin
-.TP
-.B \-csv
-Set output mode to CSV (comma separated values).
-.TP
-.B \-echo
-Print commands before execution.
-.TP
-.BI \-init\  file
-Read and execute commands from
-.I file
-, which can contain a mix of SQL statements and meta-commands.
-.TP
-.B \-[no]header
-Turn headers on or off.
-.TP
-.B \-help
-Show help on options and exit.
-.TP
-.B \-html
-Query results will be output as simple HTML tables.
-.TP
-.B \-interactive
-Force interactive I/O.
-.TP
-.B \-line
-Query results will be displayed with one value per line, rows
-separated by a blank line.  Designed to be easily parsed by
-scripts or other programs
-.TP
-.B \-list
-Query results will be displayed with the separator (|, by default)
-character between each field value.  The default.
-.TP
-.BI \-mmap\  N
-Set default mmap size to
-.I N
-\.
-.TP
-.BI \-nullvalue\  string
-Set string used to represent NULL values.  Default is ''
-(empty string).
-.TP
-.BI \-separator\  separator
-Set output field separator.  Default is '|'.
-.TP
-.B \-stats
-Print memory stats before each finalize.
-.TP
-.B \-version
-Show SQLite version.
-.TP
-.BI \-vfs\  name
-Use
-.I name
-as the default VFS.
+
+The available commands differ by version and build options, so they
+are not listed here. Please refer to your local copy for all available
+options.
 
 
 .SH INIT FILE
@@ -265,22 +137,25 @@ continue prompt = "   ...> "
 .sp
 .fi
 
-o If the file 
+o If the file
+.B ${XDG_CONFIG_HOME}/sqlite3/sqliterc
+or
 .B ~/.sqliterc
-exists, it is processed first.
-can be found in the user's home directory, it is
-read and processed.  It should generally only contain meta-commands.
+exists, the first of those to be found is processed during startup.
+It should generally only contain meta-commands.
 
 o If the -init option is present, the specified file is processed.
 
 o All other command line options are processed.
 
 .SH SEE ALSO
-http://www.sqlite.org/cli.html
+https://sqlite.org/cli.html
+.br
+https://sqlite.org/fiddle (a WebAssembly build of the CLI app)
 .br
 The sqlite3-doc package.
 .SH AUTHOR
 This manual page was originally written by Andreas Rottmann
 <rotty@debian.org>, for the Debian GNU/Linux system (but may be used
-by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com> and
-further updated by Laszlo Boszormenyi <gcs@debian.hu> .
+by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com>,
+Laszlo Boszormenyi <gcs@debian.hu>, and the sqlite3 developers.