Index: sqlite.1 ================================================================== --- sqlite.1 +++ sqlite.1 @@ -1,10 +1,10 @@ .\" Hey, EMACS: -*- nroff -*- .\" 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 SQLITE SECTION "January 2, 2002" +.TH SQLITE 1 "Mon Apr 15 23:49:17 2002" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: .\" .nh disable hyphenation .\" .hy enable hyphenation @@ -71,23 +71,43 @@ any time. For example: .sp .nf .cc | sqlite> .help -.dump Dump database in a text format +.dump ?TABLE? ... Dump the database in an text format +.echo ON|OFF Turn command echo on or off .exit Exit this program -.explain Set output mode suitable for EXPLAIN -.header ON|OFF Turn display of headers on or off +.explain ON|OFF Turn output mode suitable for EXPLAIN on or off. + "off" will revert to the output mode that was + previously in effect +.header(s) ON|OFF Turn display of headers on or off .help Show this message .indices TABLE Show names of all indices on TABLE -.mode MODE Set mode to one of "line", "column", "list", or "html" +.mode MODE Set mode to one of "line(s)", "column(s)", + "insert", "list", or "html" .mode insert TABLE Generate SQL insert statements for TABLE +.nullvalue STRING Print STRING instead of nothing for NULL data .output FILENAME Send output to FILENAME .output stdout Send output to the screen +.prompt MAIN CONTINUE Replace the standard prompts + "sqlite > " and " ...> " + with the strings MAIN and CONTINUE + CONTINUE is optional. +.quit Exit this program +.read FILENAME Execute SQL in FILENAME +.reindex ?TABLE? Rebuild indices .schema ?TABLE? Show the CREATE statements .separator STRING Change separator string for "list" mode -.tables List names all tables in the database +.show Show the current values for the following: + .echo + .explain + .mode + .nullvalue + .output + .separator + .width +.tables ?PATTERN? List names of tables matching a pattern .timeout MS Try opening locked tables for MS milliseconds .width NUM NUM ... Set column widths for "column" mode sqlite> |cc . .sp @@ -94,22 +114,39 @@ .fi .SH OPTIONS The program has the following options: .TP +.BI \-init\ file +Read in and process 'file', which contains "dot commands". +You can use this file to initialize display settings. +.TP .B \-html Set output mode to HTML. .TP .B \-list Set output mode to 'list'. .TP .B \-line Set output mode to 'line'. .TP +.B \-column +Set output mode to 'column'. +.TP .BI \-seperator\ seperator -Specify which output field seperator for 'list' mode to use. +Specify which output field seperator for 'list' mode to use. Default is '|'. +.TP +.BI \-nullvalue\ string +When a null is encountered, print 'string'. Default is no string. +.TP +.B \-[no]header +Turn headers on or off. Default is off. +.TP +.B \-echo +Print commands before execution. + .SH OUTPUT MODE The SQLite program has different output modes, which define the way the output (from queries) is formatted. @@ -122,12 +159,44 @@ In HTML mode, an XHTML table is generated. In 'column' mode, one record per line is output, aligned neatly in colums. +.SH INIT FILE +sqlite can be initialized using resource files. These can be combined with +command line arguments to set up sqlite exactly the way you want it. +Initialization proceeds as follows: + +o The defaults of + +.sp +.nf +.cc | +mode = LIST +separator = "|" +main prompt = "sqlite> " +continue prompt = " ...> " +|cc . +.sp +.fi + +are established. + +o If a file .sqliterc can be found in the user's home directory, it is +read and processed. It should only contain "dot commands". If the +file is not found or cannot be read, processing continues without +notification. + +o If a file is specified on the command line with the -init option, it +is processed in the same manner as .sqliterc + +o All other command line options are processed + +o The database is opened and you are now ready to begin. + .SH SEE ALSO http://www.hwaci.com/sw/sqlite/ .br The sqlite-doc package .SH AUTHOR This manual page was written by Andreas Rottmann , for the Debian GNU/Linux system (but may be used by others).