convert to mdoc
This commit is contained in:
christos
parent
2136559eac
commit
b6b2f24e70
|
|
@ -1,112 +1,79 @@
|
|||
.\" 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 SQLITE3 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
|
||||
.\" .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
|
||||
\- A command line interface for SQLite version 3
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B sqlite3
|
||||
.RI [ options ]
|
||||
.RI [ databasefile ]
|
||||
.RI [ SQL ]
|
||||
|
||||
.SH SUMMARY
|
||||
.PP
|
||||
.B sqlite3
|
||||
.\" $NetBSD: sqlite3.1,v 1.2 2012/12/16 20:25:40 christos Exp $
|
||||
.Dd December 16, 2012
|
||||
.Dt SQLITE3 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm sqlite3
|
||||
.Nd A command line interface for SQLite version 3
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Ar options
|
||||
.Op Ar databasefile
|
||||
.Op Ar SQL
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
is a terminal-based front-end to the SQLite library that can evaluate
|
||||
queries interactively and display the results in multiple formats.
|
||||
.B sqlite3
|
||||
.Nm
|
||||
can also be used within shell scripts and other applications to provide
|
||||
batch processing features.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.Pp
|
||||
To start a
|
||||
.B sqlite3
|
||||
.Nm
|
||||
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.
|
||||
.Nm
|
||||
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.
|
||||
|
||||
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
|
||||
$
|
||||
.B sqlite3 mydata.db
|
||||
.br
|
||||
.Bd -literal -offset indent
|
||||
$ sqlite3 mydata.db
|
||||
SQLite version 3.1.3
|
||||
.br
|
||||
Enter ".help" for instructions
|
||||
.br
|
||||
sqlite>
|
||||
.B create table memos(text, priority INTEGER);
|
||||
.br
|
||||
sqlite>
|
||||
.B insert into memos values('deliver project description', 10);
|
||||
.br
|
||||
sqlite>
|
||||
.B insert into memos values('lunch with Christine', 100);
|
||||
.br
|
||||
sqlite>
|
||||
.B select * from memos;
|
||||
.br
|
||||
sqlite> create table memos(text, priority INTEGER);
|
||||
sqlite> insert into memos values('deliver project description', 10);
|
||||
sqlite> insert into memos values('lunch with Christine', 100);
|
||||
sqlite> select * from memos;
|
||||
deliver project description|10
|
||||
.br
|
||||
lunch with Christine|100
|
||||
.br
|
||||
sqlite>
|
||||
.sp
|
||||
|
||||
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,
|
||||
.Ed
|
||||
.Pp
|
||||
If no database name is supplied, the
|
||||
.Em ATTACH
|
||||
sql command can be used
|
||||
to attach to existing or create new database files.
|
||||
.Em 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 semi-colons.
|
||||
.Pp
|
||||
For example:
|
||||
.sp
|
||||
$
|
||||
.B sqlite3 -line mydata.db 'select * from memos where priority > 20;'
|
||||
.br
|
||||
.Bd -literal -offset indent
|
||||
$ sqlite3 -line mydata.db 'select * from memos where priority > 20;'
|
||||
text = lunch with Christine
|
||||
.br
|
||||
priority = 100
|
||||
.br
|
||||
.sp
|
||||
|
||||
.SS SQLITE META-COMMANDS
|
||||
.PP
|
||||
priority = 100
|
||||
.Ed
|
||||
.Ss SQLITE META-COMMANDS
|
||||
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
|
||||
.Dq \. .
|
||||
.Pp
|
||||
A list of available meta-commands can be viewed at any time by issuing
|
||||
the '.help' command. For example:
|
||||
.sp
|
||||
sqlite>
|
||||
.B .help
|
||||
.nf
|
||||
the '.help' command.
|
||||
For example:
|
||||
.Bd -literal -offset indent
|
||||
sqlite> .help
|
||||
.cc |
|
||||
.databases List names and files of attached databases
|
||||
.dump ?TABLE? ... Dump the database in an SQL text format
|
||||
|
|
@ -140,90 +107,81 @@ sqlite>
|
|||
.width NUM NUM ... Set column widths for "column" mode
|
||||
sqlite>
|
||||
|cc .
|
||||
.sp
|
||||
.fi
|
||||
|
||||
.SH OPTIONS
|
||||
.B sqlite3
|
||||
.Ed
|
||||
.Sh OPTIONS
|
||||
.Nm
|
||||
has the following options:
|
||||
.TP
|
||||
.BI \-init\ file
|
||||
.Bl -tag -width abcdefghij
|
||||
.It Fl init Ar file
|
||||
Read and execute commands from
|
||||
.I file
|
||||
, which can contain a mix of SQL statements and meta-commands.
|
||||
.TP
|
||||
.B \-echo
|
||||
.Ar file ,
|
||||
which can contain a mix of SQL statements and meta-commands.
|
||||
.It Fl echo
|
||||
Print commands before execution.
|
||||
.TP
|
||||
.B \-[no]header
|
||||
Turn headers on or off.
|
||||
.TP
|
||||
.B \-column
|
||||
.It Fl header
|
||||
Turn headers on.
|
||||
.It Fl noheader
|
||||
Turn headers off.
|
||||
.It Fl column
|
||||
Query results will be displayed in a table like form, using
|
||||
whitespace characters to separate the columns and align the
|
||||
output.
|
||||
.TP
|
||||
.B \-html
|
||||
.It Fl html
|
||||
Query results will be output as simple HTML tables.
|
||||
.TP
|
||||
.B \-line
|
||||
.It Fl 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
|
||||
.TP
|
||||
.B \-list
|
||||
separated by a blank line.
|
||||
Designed to be easily parsed by scripts or other programs
|
||||
.It Fl list
|
||||
Query results will be displayed with the separator (|, by default)
|
||||
character between each field value. The default.
|
||||
.TP
|
||||
.BI \-separator\ separator
|
||||
Set output field separator. Default is '|'.
|
||||
.TP
|
||||
.BI \-nullvalue\ string
|
||||
Set string used to represent NULL values. Default is ''
|
||||
character between each field value.
|
||||
.It Fl separator Ar separator
|
||||
Set output field separator.
|
||||
Default is
|
||||
.Dq | .
|
||||
.It Fl nullvalue Ar string
|
||||
Set
|
||||
.Ar string
|
||||
used to represent
|
||||
.Dv NULL
|
||||
values.
|
||||
Default is
|
||||
.Dq \e
|
||||
(empty string).
|
||||
.TP
|
||||
.B \-version
|
||||
.It Fl version
|
||||
Show SQLite version.
|
||||
.TP
|
||||
.B \-help
|
||||
.It Fl help
|
||||
Show help on options and exit.
|
||||
|
||||
|
||||
.SH INIT FILE
|
||||
.B sqlite3
|
||||
.El
|
||||
.Ss INIT FILE
|
||||
.Nm
|
||||
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:
|
||||
|
||||
o The default configuration is established as follows:
|
||||
|
||||
interactive environment.
|
||||
Throughout initialization, any previously specified setting can be overridden. The sequence of initialization is as follows:
|
||||
.Bl
|
||||
.It The default configuration is established as follows:
|
||||
.sp
|
||||
.nf
|
||||
.Bd -literal -offset indent
|
||||
.cc |
|
||||
mode = LIST
|
||||
separator = "|"
|
||||
main prompt = "sqlite> "
|
||||
continue prompt = " ...> "
|
||||
|cc .
|
||||
.sp
|
||||
.fi
|
||||
|
||||
o If the file
|
||||
.B ~/.sqliterc
|
||||
.Ed
|
||||
.It If the file
|
||||
.Fi ~/.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.
|
||||
|
||||
.SH SEE ALSO
|
||||
read and processed.
|
||||
It should generally only contain meta-commands.
|
||||
.It If the -init option is present, the specified file is processed.
|
||||
.It All other command line options are processed.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
http://www.sqlite.org/
|
||||
.br
|
||||
The sqlite-doc package
|
||||
.SH AUTHOR
|
||||
.Sh AUTHOR
|
||||
This manual page was originally written by Andreas Rottmann
|
||||
<rotty@debian.org>, for the Debian GNU/Linux system (but may be used
|
||||
by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com>.
|
||||
\*[Lt]rotty@debian.org\*[Gt], for the Debian GNU/Linux system (but may be used
|
||||
by others).
|
||||
It was subsequently revised by Bill Bumgarner \*[Lt]bbum@mac.com\*[Gt].
|
||||
|
|
|
|||
Loading…
Reference in New Issue