Hi, Marc Espie just imported both the sqlite 3.7.11 library and the sqlite3 command line utility into the OpenBSD base system, so both will likely be an integral part of the upcoming OpenBSD 5.2 release in November 2012.
For that reason, i have done minimal cleanup of the sqlite3(1) manual page that i'd like to feed back upstream. I'd be glad if you could review and commit the patch appended below; don't hesitate to ask questions in case anything seems unclear. Here is a rationale explaining the proposed changes: * For the .TH macro, man(7) documents traditionally use the YYYY-MM-DD date format as specified in the ISO-8601 standard. * Including excerpts from the roff(7) documentation into individual manuals seems excessive, in particular when most of the explained roff requests are not used. * Trailing whitespace confused some old roff implementations, so it is better to avoid it. * man(7) doesn't allow blank lines except in literal context; better avoid them, even though most modern tools now treat them similar to .PP. On the other hand, do use .PP to start a new logical paragraph. * .PP is implied after .SH and .SS, so drop it at these places. * New sentences should start on new lines. With some tools, this helps to improve inter-sentence spacing. * In high-level man(7) code, avoid the low-level roff(7) requests .br and .sp, in particular at places where they have no effect. * Fix a typo: s/semi-colon/semicolon/. * While .cc is valid roff(7), it makes reading the source harder and some tools do not implement it. In the present case, it is easy to avoid it and to improve portability. * .Bl arguments need to be separated by white space. * Correct spacing around one comma. * Delete one stray line breaking the grammar. * Mark up the -init option in the text. * Use the standard AUTHORS section instead of a custom AUTHOR section. Thank you for maintaining sqlite! Yours, Ingo -- Ingo Schwarze <schwarze at openbsd dot org> mandoc developer - http://mdocml.bsd.lv/ Index: sqlite3.1 =================================================================== RCS file: /cvs/src/usr.bin/sqlite3/sqlite3.1,v retrieving revision 1.1 diff -u -p -r1.1 sqlite3.1 --- sqlite3.1 14 Apr 2012 13:33:10 -0000 1.1 +++ sqlite3.1 14 Apr 2012 14:47:25 -0000 @@ -2,51 +2,36 @@ .\" 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 "Mon Apr 15 23:49:17 2002" +.TH SQLITE3 1 2005-02-24 .\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp <n> insert n+1 empty lines -.\" for manpage-specific macros, see man(7) .SH NAME -.B sqlite3 +.B sqlite3 \- A command line interface for SQLite version 3 - .SH SYNOPSIS .B sqlite3 .RI [ options ] .RI [ databasefile ] .RI [ SQL ] - .SH SUMMARY -.PP .B sqlite3 is a terminal-based front-end to the SQLite library that can evaluate queries interactively and display the results in multiple formats. .B sqlite3 can also be used within shell scripts and other applications to provide batch processing features. - .SH DESCRIPTION To start a .B sqlite3 interactive session, invoke the .B sqlite3 -command and optionally provide the name of a database file. If the -database file does not exist, it will be created. If the database file -does exist, it will be opened. - +command and optionally provide the name of a database file. +If the database file does not exist, it will be created. +If the database file does exist, it will be opened. +.PP For example, to create a new database file named "mydata.db", create a table named "memos" and insert a couple of records into that table: -.sp -$ +.PP +$ .B sqlite3 mydata.db .br SQLite version 3.1.3 @@ -70,54 +55,49 @@ deliver project description|10 lunch with Christine|100 .br sqlite> -.sp - +.PP If no database name is supplied, the ATTACH sql command can be used -to attach to existing or create new database files. ATTACH can also -be used to attach to multiple databases within the same interactive -session. This is useful for migrating data between databases, +to attach to existing or create new database files. +ATTACH can also be used to attach to multiple databases within +the same interactive session. +This is useful for migrating data between databases, possibly changing the schema along the way. - +.PP Optionally, a SQL statement or set of SQL statements can be supplied as -a single argument. Multiple statements should be separated by -semi-colons. - +a single argument. +Multiple statements should be separated by semicolons. +.PP For example: -.sp -$ +.PP +$ .B sqlite3 -line mydata.db 'select * from memos where priority > 20;' .br text = lunch with Christine .br priority = 100 -.br -.sp - .SS SQLITE META-COMMANDS -.PP The interactive interpreter offers a set of meta-commands that can be used to control the output format, examine the currently attached database files, or perform administrative operations upon the -attached databases (such as rebuilding indices). Meta-commands are -always prefixed with a dot (.). - +attached databases (such as rebuilding indices). +Meta-commands are always prefixed with a dot (.). +.PP A list of available meta-commands can be viewed at any time by issuing the '.help' command. For example: -.sp +.PP sqlite> .B .help .nf -.cc | -.databases List names and files of attached databases -.dump ?TABLE? ... Dump the database in an SQL text format -.echo ON|OFF Turn command echo on or off -.exit Exit this program -.explain ON|OFF Turn output mode suitable for EXPLAIN on or off. -.header(s) 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 on TABLE -.mode MODE ?TABLE? Set output mode where MODE is one of: +\&.databases List names and files of attached databases +\&.dump ?TABLE? ... Dump the database in an SQL text format +\&.echo ON|OFF Turn command echo on or off +\&.exit Exit this program +\&.explain ON|OFF Turn output mode suitable for EXPLAIN on or off. +\&.header(s) 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 on TABLE +\&.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 @@ -126,31 +106,28 @@ sqlite> list Values delimited by .separator string tabs Tab-separated values tcl TCL list elements -.nullvalue STRING Print STRING in place of NULL values -.output FILENAME Send output to FILENAME -.output stdout Send output to the screen -.prompt MAIN CONTINUE Replace the standard prompts -.quit Exit this program -.read FILENAME Execute SQL in FILENAME -.schema ?TABLE? Show the CREATE statements -.separator STRING Change separator used by output mode and .import -.show Show the current values for various settings -.tables ?PATTERN? List names of tables matching a LIKE pattern -.timeout MS Try opening locked tables for MS milliseconds -.width NUM NUM ... Set column widths for "column" mode +\&.nullvalue STRING Print STRING in place of NULL values +\&.output FILENAME Send output to FILENAME +\&.output stdout Send output to the screen +\&.prompt MAIN CONTINUE Replace the standard prompts +\&.quit Exit this program +\&.read FILENAME Execute SQL in FILENAME +\&.schema ?TABLE? Show the CREATE statements +\&.separator STRING Change separator used by output mode and .import +\&.show Show the current values for various settings +\&.tables ?PATTERN? List names of tables matching a LIKE pattern +\&.timeout MS Try opening locked tables for MS milliseconds +\&.width NUM NUM ... Set column widths for "column" mode sqlite> -|cc . -.sp .fi - .SH OPTIONS .B sqlite3 has the following options: .TP -.BI \-init\ file +.BI \-init\ file Read and execute commands from -.I file -, which can contain a mix of SQL statements and meta-commands. +.IR file , +which can contain a mix of SQL statements and meta-commands. .TP .B \-echo Print commands before execution. @@ -168,62 +145,60 @@ Query results will be output as simple H .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 +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. +character between each field value. +The default. .TP .BI \-separator\ separator -Set output field separator. Default is '|'. +Set output field separator. +Default is '|'. .TP .BI \-nullvalue\ string -Set string used to represent NULL values. Default is '' -(empty string). +Set string used to represent NULL values. +Default is '' (empty string). .TP .B \-version Show SQLite version. .TP .B \-help Show help on options and exit. - - .SH INIT FILE .B sqlite3 reads an initialization file to set the configuration of the -interactive environment. Throughout initialization, any previously -specified setting can be overridden. The sequence of initialization is -as follows: - +interactive environment. +Throughout initialization, any previously specified setting +can be overridden. +The sequence of initialization is as follows: +.PP o The default configuration is established as follows: - .sp .nf -.cc | mode = LIST separator = "|" main prompt = "sqlite> " continue prompt = " ...> " -|cc . -.sp .fi - -o If the file +.PP +o If the file .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. - -o If the -init option is present, the specified file is processed. - +can be found in the user's home directory, it is read and processed. +It should generally only contain meta-commands. +.PP +o If the +.B \-init +option is present, the specified file is processed. +.PP o All other command line options are processed. - .SH SEE ALSO http://www.sqlite.org/ -.br +.PP The sqlite-doc package -.SH AUTHOR +.SH AUTHORS This manual page was originally written by Andreas Rottmann <ro...@debian.org>, for the Debian GNU/Linux system (but may be used -by others). It was subsequently revised by Bill Bumgarner <b...@mac.com>. +by others). +It was subsequently revised by Bill Bumgarner <b...@mac.com>. _______________________________________________ sqlite-users mailing list sqlite-users@sqlite.org http://sqlite.org:8080/cgi-bin/mailman/listinfo/sqlite-users
