/ Check-in [ff67ad40]
Login

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

Overview
Comment:Updated to match new shell.c functionality. (CVS 533)
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: ff67ad40106a20fb85797cca4c495dc34ad5519b
User & Date: persicom 2002-04-18 02:53:54
Context
2002-04-18
12:39
Change shell.c so that it will compile under windows. Shorten the help command somewhat. Add the state of ".header" to the output of ".show". (CVS 534) check-in: 0582168b user: drh tags: trunk
02:53
Updated to match new shell.c functionality. (CVS 533) check-in: ff67ad40 user: persicom tags: trunk
02:53
Mistake in help text. Spurious trailing whitespace removed. (CVS 532) check-in: 4bdd040e user: persicom tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to sqlite.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 SQLITE SECTION "January 2, 2002"
            5  +.TH SQLITE 1 "Mon Apr 15 23:49:17 2002"
     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
................................................................................
    69     69   
    70     70   For a listing of the available dot commands, you can enter ".help" at
    71     71   any time. For example:
    72     72   .sp
    73     73   .nf
    74     74   .cc |
    75     75   sqlite> .help
    76         -.dump                  Dump database in a text format
           76  +.dump ?TABLE? ...      Dump the database in an text format
           77  +.echo ON|OFF           Turn command echo on or off
    77     78   .exit                  Exit this program
    78         -.explain               Set output mode suitable for EXPLAIN
    79         -.header ON|OFF         Turn display of headers on or off
           79  +.explain ON|OFF        Turn output mode suitable for EXPLAIN on or off.
           80  +                       "off" will revert to the output mode that was
           81  +                       previously in effect
           82  +.header(s) ON|OFF      Turn display of headers on or off
    80     83   .help                  Show this message
    81     84   .indices TABLE         Show names of all indices on TABLE
    82         -.mode MODE             Set mode to one of "line", "column", "list", or "html"
           85  +.mode MODE             Set mode to one of "line(s)", "column(s)",
           86  +                       "insert", "list", or "html"
    83     87   .mode insert TABLE     Generate SQL insert statements for TABLE
           88  +.nullvalue STRING      Print STRING instead of nothing for NULL data
    84     89   .output FILENAME       Send output to FILENAME
    85     90   .output stdout         Send output to the screen
           91  +.prompt MAIN CONTINUE  Replace the standard prompts
           92  +                       "sqlite > " and "   ...> "
           93  +                       with the strings MAIN and CONTINUE
           94  +                       CONTINUE is optional.
           95  +.quit                  Exit this program
           96  +.read FILENAME         Execute SQL in FILENAME
           97  +.reindex ?TABLE?       Rebuild indices
    86     98   .schema ?TABLE?        Show the CREATE statements
    87     99   .separator STRING      Change separator string for "list" mode
    88         -.tables                List names all tables in the database
          100  +.show                  Show the current values for the following:
          101  +                       .echo
          102  +                       .explain
          103  +                       .mode
          104  +                       .nullvalue
          105  +                       .output
          106  +                       .separator
          107  +                       .width
          108  +.tables ?PATTERN?      List names of tables matching a pattern
    89    109   .timeout MS            Try opening locked tables for MS milliseconds
    90    110   .width NUM NUM ...     Set column widths for "column" mode
    91    111   sqlite>
    92    112   |cc .
    93    113   .sp
    94    114   .fi
    95    115   
    96    116   .SH OPTIONS
    97    117   The program has the following options:
    98    118   .TP
          119  +.BI \-init\ file
          120  +Read in and process 'file', which contains "dot commands".
          121  +You can use this file to initialize display settings.
          122  +.TP
    99    123   .B \-html
   100    124   Set output mode to HTML.
   101    125   .TP
   102    126   .B \-list
   103    127   Set output mode to 'list'.
   104    128   .TP
   105    129   .B \-line
   106    130   Set output mode to 'line'.
   107    131   .TP
          132  +.B \-column
          133  +Set output mode to 'column'.
          134  +.TP
   108    135   .BI \-seperator\  seperator
   109         -Specify which output field seperator for 'list' mode to use. 
          136  +Specify which output field seperator for 'list' mode to use.
   110    137   Default is '|'.
          138  +.TP
          139  +.BI \-nullvalue\  string
          140  +When a null is encountered, print 'string'. Default is no string.
          141  +.TP
          142  +.B \-[no]header
          143  +Turn headers on or off. Default is off.
          144  +.TP
          145  +.B \-echo
          146  +Print commands before execution.
          147  +
   111    148   
   112    149   .SH OUTPUT MODE
   113    150   The SQLite program has different output modes, which define the way
   114    151   the output (from queries) is formatted.
   115    152   
   116    153   In 'list' mode, which is the default, one record per line is output,
   117    154   each field seperated by the seperator specified with the
................................................................................
   120    157   In 'line' mode, each column is output on its own line, records are
   121    158   seperated by blank lines.
   122    159   
   123    160   In HTML mode, an XHTML table is generated.
   124    161   
   125    162   In 'column' mode, one record per line is output, aligned neatly in colums.
   126    163   
          164  +.SH INIT FILE
          165  +sqlite can be initialized using resource files. These can be combined with
          166  +command line arguments to set up sqlite exactly the way you want it.
          167  +Initialization proceeds as follows:
          168  +
          169  +o The defaults of
          170  +
          171  +.sp
          172  +.nf
          173  +.cc |
          174  +mode            = LIST
          175  +separator       = "|"
          176  +main prompt     = "sqlite> "
          177  +continue prompt = "   ...> "
          178  +|cc .
          179  +.sp
          180  +.fi
          181  +
          182  +are established.
          183  +
          184  +o If a file .sqliterc can be found in the user's home directory, it is
          185  +read and processed. It should only contain "dot commands".  If the
          186  +file is not found or cannot be read, processing continues without
          187  +notification.
          188  +
          189  +o If a file is specified on the command line with the -init option, it
          190  +is processed in the same manner as .sqliterc
          191  +
          192  +o All other command line options are processed
          193  +
          194  +o The database is opened and you are now ready to begin.
          195  +
   127    196   .SH SEE ALSO
   128    197   http://www.hwaci.com/sw/sqlite/
   129    198   .br
   130    199   The sqlite-doc package
   131    200   .SH AUTHOR
   132    201   This manual page was written by Andreas Rottmann <rotty@debian.org>,
   133    202   for the Debian GNU/Linux system (but may be used by others).