/ Check-in [67f0d469]
Login

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

Overview
Comment:Change the command-line shell man-page to use the ".tr" troff directive instead of ".cc" for escaping the initial "." characters in the ".help" output.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:67f0d469da28c023200239a1f3d0c6cef9ef0e45
User & Date: drh 2014-10-31 14:46:51
Context
2014-11-01
18:32
Add requirements marks and make minor tweaks to documentation. check-in: 49188b2b user: drh tags: trunk
2014-10-31
20:11
Add the experimental sqlite3_stmt_scanstatus() API. check-in: 6a9bab34 user: dan tags: scanstatus
15:20
Merge all recent trunk enhancements into the apple-osx branch. check-in: fef8430f user: drh tags: apple-osx
14:53
Merge recent trunk enhancements, and in particular the improvements to the b-tree balancing logic, into the sessions branch. check-in: 28b044a5 user: drh tags: sessions
14:46
Change the command-line shell man-page to use the ".tr" troff directive instead of ".cc" for escaping the initial "." characters in the ".help" output. check-in: 67f0d469 user: drh tags: trunk
14:26
Simplify the logic in the cell redistribution loop of balance_nonroot(). Enhance and clarify comments and add assert() statements for additional verification of correctness. check-in: a07078b6 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 Jan 31 11:14:00 2014"
            5  +.TH SQLITE3 1 "Fri Oct 31 10:41:31 EDT 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.8.3
           52  +SQLite version 3.8.8
    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>
................................................................................
   103    103   
   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         -.cc |
   111         -.backup ?DB? FILE      Backup DB (default "main") to FILE
   112         -.bail ON|OFF           Stop after hitting an error.  Default OFF
   113         -.databases             List names and files of attached databases
   114         -.dump ?TABLE? ...      Dump the database in an SQL text format
          110  +.tr %.
          111  +%backup ?DB? FILE      Backup DB (default "main") to FILE
          112  +%bail on|off           Stop after hitting an error.  Default OFF
          113  +%clone NEWDB           Clone data into NEWDB from the existing database
          114  +%databases             List names and files of attached databases
          115  +%dump ?TABLE? ...      Dump the database in an SQL text format
   115    116                            If TABLE specified, only dump tables matching
   116    117                            LIKE pattern TABLE.
   117         -.echo ON|OFF           Turn command echo on or off
   118         -.exit                  Exit this program
   119         -.explain ?ON|OFF?      Turn output mode suitable for EXPLAIN on or off.
          118  +%echo on|off           Turn command echo on or off
          119  +%eqp on|off            Enable or disable automatic EXPLAIN QUERY PLAN
          120  +%exit                  Exit this program
          121  +%explain ?on|off?      Turn output mode suitable for EXPLAIN on or off.
   120    122                            With no args, it turns EXPLAIN on.
   121         -.header(s) ON|OFF      Turn display of headers on or off
   122         -.help                  Show this message
   123         -.import FILE TABLE     Import data from FILE into TABLE
   124         -.indices ?TABLE?       Show names of all indices
          123  +%fullschema            Show schema and the content of sqlite_stat tables
          124  +%headers on|off        Turn display of headers on or off
          125  +%help                  Show this message
          126  +%import FILE TABLE     Import data from FILE into TABLE
          127  +%indices ?TABLE?       Show names of all indices
   125    128                            If TABLE specified, only show indices for tables
   126    129                            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
   129         -.mode MODE ?TABLE?     Set output mode where MODE is one of:
          130  +%load FILE ?ENTRY?     Load an extension library
          131  +%log FILE|off          Turn logging on or off.  FILE can be stderr/stdout
          132  +%mode MODE ?TABLE?     Set output mode where MODE is one of:
   130    133                            csv      Comma-separated values
   131    134                            column   Left-aligned columns.  (See .width)
   132    135                            html     HTML <table> code
   133    136                            insert   SQL insert statements for TABLE
   134    137                            line     One value per line
   135    138                            list     Values delimited by .separator string
   136    139                            tabs     Tab-separated values
   137    140                            tcl      TCL list elements
   138         -.nullvalue STRING      Use STRING in place of NULL values
   139         -.open ?FILENAME?       Close existing database and reopen FILENAME
   140         -.output FILENAME       Send output to FILENAME
   141         -.output stdout         Send output to the screen
   142         -.print STRING...       Print literal STRING
   143         -.prompt MAIN CONTINUE  Replace the standard prompts
   144         -.quit                  Exit this program
   145         -.read FILENAME         Execute SQL in FILENAME
   146         -.restore ?DB? FILE     Restore content of DB (default "main") from FILE
   147         -.schema ?TABLE?        Show the CREATE statements
          141  +%nullvalue STRING      Use STRING in place of NULL values
          142  +%once FILENAME         Output for the next SQL command only to FILENAME
          143  +%open ?FILENAME?       Close existing database and reopen FILENAME
          144  +%output ?FILENAME?     Send output to FILENAME or stdout
          145  +%print STRING...       Print literal STRING
          146  +%prompt MAIN CONTINUE  Replace the standard prompts
          147  +%quit                  Exit this program
          148  +%read FILENAME         Execute SQL in FILENAME
          149  +%restore ?DB? FILE     Restore content of DB (default "main") from FILE
          150  +%save FILE             Write in-memory database into FILE
          151  +%schema ?TABLE?        Show the CREATE statements
   148    152                            If TABLE specified, only show tables matching
   149    153                            LIKE pattern TABLE.
   150         -.separator STRING      Change separator used by output mode and .import
   151         -.show                  Show the current values for various settings
   152         -.stats ON|OFF          Turn stats on or off
   153         -.tables ?TABLE?        List names of tables
          154  +%separator STRING ?NL? Change separator used by output mode and .import
          155  +                         NL is the end-of-line mark for CSV
          156  +%shell CMD ARGS...     Run CMD ARGS... in a system shell
          157  +%show                  Show the current values for various settings
          158  +%stats on|off          Turn stats on or off
          159  +%system CMD ARGS...    Run CMD ARGS... in a system shell
          160  +%tables ?TABLE?        List names of tables
   154    161                            If TABLE specified, only list tables matching
   155    162                            LIKE pattern TABLE.
   156         -.timeout MS            Try opening locked tables for MS milliseconds
   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
          163  +%timeout MS            Try opening locked tables for MS milliseconds
          164  +%timer on|off          Turn SQL timer on or off
          165  +%trace FILE|off        Output each SQL statement as it is run
          166  +%vfsname ?AUX?         Print the name of the VFS stack
          167  +%width NUM1 NUM2 ...   Set column widths for "column" mode
          168  +                         Negative values right-justify
   161    169   sqlite>
   162         -|cc .
   163    170   .sp
   164    171   .fi
   165    172   .SH OPTIONS
   166    173   .B sqlite3
   167    174   has the following options:
   168    175   .TP
   169    176   .B \-bail
................................................................................
   265    272   read and processed.  It should generally only contain meta-commands.
   266    273   
   267    274   o If the -init option is present, the specified file is processed.
   268    275   
   269    276   o All other command line options are processed.
   270    277   
   271    278   .SH SEE ALSO
   272         -http://www.sqlite.org/
          279  +http://www.sqlite.org/cli.html
   273    280   .br
   274    281   The sqlite3-doc package.
   275    282   .SH AUTHOR
   276    283   This manual page was originally written by Andreas Rottmann
   277    284   <rotty@debian.org>, for the Debian GNU/Linux system (but may be used
   278    285   by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com> and
   279    286   further updated by Laszlo Boszormenyi <gcs@debian.hu> .