On Thu, 30 Oct 2014 17:37:54 +0100 (CET)
Carsten Kunze <carsten.ku...@arcor.de> wrote:
> the man page sqlite3.1 contains the .cc request which is not
> compatible with the man macro package (and hence must not be used in
> a man page).
The below patch rectifies that problem and clears up some others
besides:
1. replace blank lines with .sp requests or .PP
2. remove blank-line request prior to and after .SH
3. number the initialization steps
4. mark paragraphs with .PP instead of .sp
5. make option list more compact
I took it upon myself to clarify the wording slightly.
The patch might not apply cleanly to the trunk because it's based on an
older version (the latest I have handy). Hope it's useful anyway.
--jkl
[snip]
--- projects/database/sqlite3/sqlite3.1 2012-07-25
12:32:57.000000000 -0400
+++ /usr/local/share/man/man1/sqlite3.1
2014-10-31 17:34:06.000000000 -0400 @@ -18,13 +18,13 @@
.SH NAME
.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
@@ -33,7 +33,7 @@
.B sqlite3
can also be used within shell scripts and other applications to provide
batch processing features.
-
+.
.SH DESCRIPTION
To start a
.B sqlite3
@@ -42,10 +42,11 @@
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
@@ -70,29 +71,28 @@
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,
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.
-
-For example:
-.sp
+semi-colons. For example:
+.PP
$
-.B sqlite3 -line mydata.db 'select * from memos where priority > 20;'
+.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
@@ -100,24 +100,26 @@
database files, or perform administrative operations upon the
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
+the
+.B .help
+command:
+.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,27 +128,25 @@
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
+.TP \w'-[no]header\0'u
.BI \-init\ file
Read and execute commands from
.I file
@@ -187,43 +187,46 @@
.TP
.B \-help
Show help on options and exit.
-
-
+.
.SH INIT FILE
.B sqlite3
-reads an initialization file to set the configuration of the
+reads an initialization file to configure the
interactive environment. Throughout initialization, any previously
specified setting can be overridden. The sequence of initialization is
as follows:
-
-o The default configuration is established as follows:
-
-.sp
+.
+.nr N# +0 1
+.
+.LP
+\n+(N#. The default configuration:
+.PP
+.RS 3
.nf
-.cc |
mode = LIST
separator = "|"
main prompt = "sqlite> "
continue prompt = " ...> "
-|cc .
-.sp
+.RE
.fi
-
-o If the file
+.HP 3
+\n+(N#.\ 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.
-
-o All other command line options are processed.
-
+.
+.HP
+\n+(N#. If the -init option is present, the specified file is
processed. +.
+.HP
+\n+(N#. All other command line options are processed.
+.
.SH SEE ALSO
+.PP
http://www.sqlite.org/
-.br
+.PP
The sqlite-doc package
.SH AUTHOR
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>. +
[pins]
_______________________________________________
sqlite-users mailing list
sqlite-users@sqlite.org
http://sqlite.org:8080/cgi-bin/mailman/listinfo/sqlite-users
