summaryrefslogtreecommitdiff
path: root/sqlcipher.1
diff options
context:
space:
mode:
Diffstat (limited to 'sqlcipher.1')
-rw-r--r--sqlcipher.194
1 files changed, 72 insertions, 22 deletions
diff --git a/sqlcipher.1 b/sqlcipher.1
index 3a83046..1aafd45 100644
--- a/sqlcipher.1
+++ b/sqlcipher.1
@@ -2,7 +2,7 @@
.\" 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 SQLCIPHER 1 "Mon Apr 15 23:49:17 2002"
+.TH SQLCIPHER 1 "Mon Jan 31 11:14:00 2014"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -49,7 +49,7 @@ a table named "memos" and insert a couple of records into that table:
$
.B sqlcipher mydata.db
.br
-SQLite version 2.0.3
+SQLite version 3.8.3
.br
Enter ".help" for instructions
.br
@@ -108,15 +108,24 @@ sqlite>
.B .help
.nf
.cc |
+.backup ?DB? FILE Backup DB (default "main") to FILE
+.bail ON|OFF Stop after hitting an error. Default OFF
.databases List names and files of attached databases
.dump ?TABLE? ... Dump the database in an SQL text format
+ If TABLE specified, only dump tables matching
+ LIKE pattern TABLE.
.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.
+.explain ?ON|OFF? Turn output mode suitable for EXPLAIN on or off.
+ With no args, it turns EXPLAIN on.
.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
+.indices ?TABLE? Show names of all indices
+ If TABLE specified, only show indices for tables
+ matching LIKE pattern TABLE.
+.load FILE ?ENTRY? Load an extension library
+.log FILE|off Turn logging on or off. FILE can be stderr/stdout
.mode MODE ?TABLE? Set output mode where MODE is one of:
csv Comma-separated values
column Left-aligned columns. (See .width)
@@ -126,46 +135,76 @@ sqlite>
list Values delimited by .separator string
tabs Tab-separated values
tcl TCL list elements
-.nullvalue STRING Print STRING in place of NULL values
+.nullvalue STRING Use STRING in place of NULL values
+.open ?FILENAME? Close existing database and reopen FILENAME
.output FILENAME Send output to FILENAME
.output stdout Send output to the screen
+.print STRING... Print literal STRING
.prompt MAIN CONTINUE Replace the standard prompts
.quit Exit this program
.read FILENAME Execute SQL in FILENAME
+.restore ?DB? FILE Restore content of DB (default "main") from FILE
.schema ?TABLE? Show the CREATE statements
+ If TABLE specified, only show tables matching
+ LIKE pattern TABLE.
.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
+.stats ON|OFF Turn stats on or off
+.tables ?TABLE? List names of tables
+ If TABLE specified, only list tables matching
+ LIKE pattern TABLE.
.timeout MS Try opening locked tables for MS milliseconds
-.width NUM NUM ... Set column widths for "column" mode
+.trace FILE|off Output each SQL statement as it is run
+.vfsname ?AUX? Print the name of the VFS stack
+.width NUM1 NUM2 ... Set column widths for "column" mode
+.timer ON|OFF Turn the CPU timer measurement on or off
sqlite>
|cc .
.sp
.fi
-
.SH OPTIONS
.B sqlcipher
has the following options:
.TP
-.BI \-init\ file
-Read and execute commands from
-.I file
-, which can contain a mix of SQL statements and meta-commands.
+.B \-bail
+Stop after hitting an error.
+.TP
+.B \-batch
+Force batch I/O.
+.TP
+.B \-column
+Query results will be displayed in a table like form, using
+whitespace characters to separate the columns and align the
+output.
+.TP
+.BI \-cmd\ command
+run
+.I command
+before reading stdin
+.TP
+.B \-csv
+Set output mode to CSV (comma separated values).
.TP
.B \-echo
Print commands before execution.
.TP
+.BI \-init\ file
+Read and execute commands from
+.I file
+, which can contain a mix of SQL statements and meta-commands.
+.TP
.B \-[no]header
Turn headers on or off.
.TP
-.B \-column
-Query results will be displayed in a table like form, using
-whitespace characters to separate the columns and align the
-output.
+.B \-help
+Show help on options and exit.
.TP
.B \-html
Query results will be output as simple HTML tables.
.TP
+.B \-interactive
+Force interactive I/O.
+.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
@@ -175,18 +214,28 @@ scripts or other programs
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 '|'.
+.BI \-mmap\ N
+Set default mmap size to
+.I N
+\.
.TP
.BI \-nullvalue\ string
Set string used to represent NULL values. Default is ''
(empty string).
.TP
+.BI \-separator\ separator
+Set output field separator. Default is '|'.
+.TP
+.B \-stats
+Print memory stats before each finalize.
+.TP
.B \-version
Show SQLite version.
.TP
-.B \-help
-Show help on options and exit.
+.BI \-vfs\ name
+Use
+.I name
+as the default VFS.
.SH INIT FILE
@@ -222,8 +271,9 @@ o All other command line options are processed.
.SH SEE ALSO
http://www.sqlcipher.net/
.br
-The sqlite-doc package
+The sqlite3-doc package.
.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>.
+by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com> and
+further updated by Laszlo Boszormenyi <gcs@debian.hu> .