/ Check-in [21ce9e3a]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Update the "sqlite3.1" unix manpage document.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 21ce9e3a53aed62fbe075b0dbed9faa00218aadc
User & Date: drh 2014-01-31 11:50:20
Context
2014-02-03
13:49
Minor change to TEA extension docs in an attempt to make links work correctly. check-in: af3c775e user: drh tags: trunk
2014-01-31
11:50
Update the "sqlite3.1" unix manpage document. check-in: 21ce9e3a user: drh tags: trunk
2014-01-30
17:47
Update evidence marks on SELECT tests. Comment changes only. No changes to code or tests. check-in: 1973d80e user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to sqlite3.1.

     1      1   .\"                                      Hey, EMACS: -*- nroff -*-
     2      2   .\" First parameter, NAME, should be all caps
     3      3   .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
     4      4   .\" other parameters are allowed: see man(7), man(1)
     5         -.TH SQLITE3 1 "Mon Apr 15 23:49:17 2002"
            5  +.TH SQLITE3 1 "Mon Jan 31 11:14:00 2014"
     6      6   .\" Please adjust this date whenever revising the manpage.
     7      7   .\"
     8      8   .\" Some roff macros, for reference:
     9      9   .\" .nh        disable hyphenation
    10     10   .\" .hy        enable hyphenation
    11     11   .\" .ad l      left justify
    12     12   .\" .ad b      justify to both left and right margins
................................................................................
    45     45   
    46     46   For example, to create a new database file named "mydata.db", create
    47     47   a table named "memos" and insert a couple of records into that table:
    48     48   .sp
    49     49   $ 
    50     50   .B sqlite3 mydata.db
    51     51   .br
    52         -SQLite version 3.1.3
           52  +SQLite version 3.8.3
    53     53   .br
    54     54   Enter ".help" for instructions
    55     55   .br
    56     56   sqlite>
    57     57   .B create table memos(text, priority INTEGER);
    58     58   .br
    59     59   sqlite>
................................................................................
   104    104   A list of available meta-commands can be viewed at any time by issuing
   105    105   the '.help' command.  For example:
   106    106   .sp
   107    107   sqlite>
   108    108   .B .help
   109    109   .nf
   110    110   .cc |
          111  +.backup ?DB? FILE      Backup DB (default "main") to FILE
          112  +.bail ON|OFF           Stop after hitting an error.  Default OFF
   111    113   .databases             List names and files of attached databases
   112    114   .dump ?TABLE? ...      Dump the database in an SQL text format
          115  +                         If TABLE specified, only dump tables matching
          116  +                         LIKE pattern TABLE.
   113    117   .echo ON|OFF           Turn command echo on or off
   114    118   .exit                  Exit this program
   115         -.explain ON|OFF        Turn output mode suitable for EXPLAIN on or off.
          119  +.explain ?ON|OFF?      Turn output mode suitable for EXPLAIN on or off.
          120  +                         With no args, it turns EXPLAIN on.
   116    121   .header(s) ON|OFF      Turn display of headers on or off
   117    122   .help                  Show this message
   118    123   .import FILE TABLE     Import data from FILE into TABLE
   119         -.indices TABLE         Show names of all indices on TABLE
          124  +.indices ?TABLE?       Show names of all indices
          125  +                         If TABLE specified, only show indices for tables
          126  +                         matching LIKE pattern TABLE.
          127  +.load FILE ?ENTRY?     Load an extension library
          128  +.log FILE|off          Turn logging on or off.  FILE can be stderr/stdout
   120    129   .mode MODE ?TABLE?     Set output mode where MODE is one of:
   121    130                            csv      Comma-separated values
   122    131                            column   Left-aligned columns.  (See .width)
   123    132                            html     HTML <table> code
   124    133                            insert   SQL insert statements for TABLE
   125    134                            line     One value per line
   126    135                            list     Values delimited by .separator string
   127    136                            tabs     Tab-separated values
   128    137                            tcl      TCL list elements
   129         -.nullvalue STRING      Print STRING in place of NULL values
          138  +.nullvalue STRING      Use STRING in place of NULL values
          139  +.open ?FILENAME?       Close existing database and reopen FILENAME
   130    140   .output FILENAME       Send output to FILENAME
   131    141   .output stdout         Send output to the screen
          142  +.print STRING...       Print literal STRING
   132    143   .prompt MAIN CONTINUE  Replace the standard prompts
   133    144   .quit                  Exit this program
   134    145   .read FILENAME         Execute SQL in FILENAME
          146  +.restore ?DB? FILE     Restore content of DB (default "main") from FILE
   135    147   .schema ?TABLE?        Show the CREATE statements
          148  +                         If TABLE specified, only show tables matching
          149  +                         LIKE pattern TABLE.
   136    150   .separator STRING      Change separator used by output mode and .import
   137    151   .show                  Show the current values for various settings
   138         -.tables ?PATTERN?      List names of tables matching a LIKE pattern
          152  +.stats ON|OFF          Turn stats on or off
          153  +.tables ?TABLE?        List names of tables
          154  +                         If TABLE specified, only list tables matching
          155  +                         LIKE pattern TABLE.
   139    156   .timeout MS            Try opening locked tables for MS milliseconds
   140         -.width NUM NUM ...     Set column widths for "column" mode
          157  +.trace FILE|off        Output each SQL statement as it is run
          158  +.vfsname ?AUX?         Print the name of the VFS stack
          159  +.width NUM1 NUM2 ...   Set column widths for "column" mode
          160  +.timer ON|OFF          Turn the CPU timer measurement on or off
   141    161   sqlite>
   142    162   |cc .
   143    163   .sp
   144    164   .fi
   145         -
   146    165   .SH OPTIONS
   147    166   .B sqlite3
   148    167   has the following options:
   149    168   .TP
   150         -.BI \-init\ file
   151         -Read and execute commands from
   152         -.I file
   153         -, which can contain a mix of SQL statements and meta-commands.
          169  +.B \-bail
          170  +Stop after hitting an error.
   154    171   .TP
   155         -.B \-echo
   156         -Print commands before execution.
   157         -.TP
   158         -.B \-[no]header
   159         -Turn headers on or off.
          172  +.B \-batch
          173  +Force batch I/O.
   160    174   .TP
   161    175   .B \-column
   162    176   Query results will be displayed in a table like form, using
   163    177   whitespace characters to separate the columns and align the
   164    178   output.
   165    179   .TP
          180  +.BI \-cmd\  command
          181  +run
          182  +.I command
          183  +before reading stdin
          184  +.TP
          185  +.B \-csv
          186  +Set output mode to CSV (comma separated values).
          187  +.TP
          188  +.B \-echo
          189  +Print commands before execution.
          190  +.TP
          191  +.BI \-init\  file
          192  +Read and execute commands from
          193  +.I file
          194  +, which can contain a mix of SQL statements and meta-commands.
          195  +.TP
          196  +.B \-[no]header
          197  +Turn headers on or off.
          198  +.TP
          199  +.B \-help
          200  +Show help on options and exit.
          201  +.TP
   166    202   .B \-html
   167    203   Query results will be output as simple HTML tables.
   168    204   .TP
          205  +.B \-interactive
          206  +Force interactive I/O.
          207  +.TP
   169    208   .B \-line
   170    209   Query results will be displayed with one value per line, rows
   171    210   separated by a blank line.  Designed to be easily parsed by
   172    211   scripts or other programs
   173    212   .TP
   174    213   .B \-list
   175    214   Query results will be displayed with the separator (|, by default)
   176    215   character between each field value.  The default.
   177    216   .TP
   178         -.BI \-separator\  separator
   179         -Set output field separator.  Default is '|'.
          217  +.BI \-mmap\  N
          218  +Set default mmap size to
          219  +.I N
          220  +\.
   180    221   .TP
   181    222   .BI \-nullvalue\  string
   182    223   Set string used to represent NULL values.  Default is ''
   183    224   (empty string).
   184    225   .TP
          226  +.BI \-separator\  separator
          227  +Set output field separator.  Default is '|'.
          228  +.TP
          229  +.B \-stats
          230  +Print memory stats before each finalize.
          231  +.TP
   185    232   .B \-version
   186    233   Show SQLite version.
   187    234   .TP
   188         -.B \-help
   189         -Show help on options and exit.
          235  +.BI \-vfs\  name
          236  +Use
          237  +.I name
          238  +as the default VFS.
   190    239   
   191    240   
   192    241   .SH INIT FILE
   193    242   .B sqlite3
   194    243   reads an initialization file to set the configuration of the
   195    244   interactive environment.  Throughout initialization, any previously
   196    245   specified setting can be overridden.  The sequence of initialization is
................................................................................
   218    267   o If the -init option is present, the specified file is processed.
   219    268   
   220    269   o All other command line options are processed.
   221    270   
   222    271   .SH SEE ALSO
   223    272   http://www.sqlite.org/
   224    273   .br
   225         -The sqlite-doc package
          274  +The sqlite3-doc package.
   226    275   .SH AUTHOR
   227    276   This manual page was originally written by Andreas Rottmann
   228    277   <rotty@debian.org>, for the Debian GNU/Linux system (but may be used
   229         -by others).   It was subsequently revised by Bill Bumgarner <bbum@mac.com>.
          278  +by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com> and
          279  +further updated by Laszlo Boszormenyi <gcs@debian.hu> .