add a sqlcipher.1 manpage

3 files changed, 466 insertions, 0 deletions

diff --git a/debian/patches/10-sqlcipher-man-page.patch b/debian/patches/10-sqlcipher-man-page.patch
new file mode 100644
index 0000000..66d5d1b
--- /dev/null
+++ b/debian/patches/10-sqlcipher-man-page.patch
@@ -0,0 +1,464 @@
+--- a/sqlite3.1	2012-03-30 20:53:11.000000000 -0400
++++ /dev/null	2012-03-31 10:49:42.330855572 -0400
+@@ -1,229 +0,0 @@
+-.\"                                      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
+-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.
+-
+-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
+-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
+-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,
+-possibly changing the schema along the way.
+-
+-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
+-$ 
+-.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 (.).
+-
+-A list of available meta-commands can be viewed at any time by issuing
+-the '.help' command.  For example:
+-.sp
+-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:
+-                         csv      Comma-separated values
+-                         column   Left-aligned columns.  (See .width)
+-                         html     HTML <table> code
+-                         insert   SQL insert statements for TABLE
+-                         line     One value per line
+-                         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
+-sqlite>
+-|cc .
+-.sp
+-.fi
+-
+-.SH OPTIONS
+-.B sqlite3
+-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.
+-.TP
+-.B \-echo
+-Print commands before execution.
+-.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.
+-.TP
+-.B \-html
+-Query results will be output as simple HTML tables.
+-.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
+-.TP
+-.B \-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 ''
+-(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:
+-
+-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 
+-.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.
+-
+-.SH SEE ALSO
+-http://www.sqlite.org/
+-.br
+-The sqlite-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>.
+--- /dev/null	2012-03-31 10:49:42.330855572 -0400
++++ b/sqlcipher.1	2012-03-31 20:07:20.000000000 -0400
+@@ -0,0 +1,229 @@
++.\"                                      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 SQLCIPHER 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 sqlcipher 
++\- A command line interface for SQLCipher version 2
++
++.SH SYNOPSIS
++.B sqlcipher
++.RI [ options ]
++.RI [ databasefile ]
++.RI [ SQL ]
++
++.SH SUMMARY
++.PP
++.B sqlcipher
++is a terminal-based front-end to the SQLCipher library that can evaluate
++queries interactively and display the results in multiple formats.
++.B sqlcipher
++can also be used within shell scripts and other applications to provide
++batch processing features.
++
++.SH DESCRIPTION
++To start a
++.B sqlcipher
++interactive session, invoke the
++.B sqlcipher
++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 sqlcipher mydata.db
++.br
++SQLite version 2.0.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
++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,
++possibly changing the schema along the way.
++
++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
++$ 
++.B sqlcipher -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 (.).
++
++A list of available meta-commands can be viewed at any time by issuing
++the '.help' command.  For example:
++.sp
++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:
++                         csv      Comma-separated values
++                         column   Left-aligned columns.  (See .width)
++                         html     HTML <table> code
++                         insert   SQL insert statements for TABLE
++                         line     One value per line
++                         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
++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.
++.TP
++.B \-echo
++Print commands before execution.
++.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.
++.TP
++.B \-html
++Query results will be output as simple HTML tables.
++.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
++.TP
++.B \-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 ''
++(empty string).
++.TP
++.B \-version
++Show SQLite version.
++.TP
++.B \-help
++Show help on options and exit.
++
++
++.SH INIT FILE
++.B sqlcipher
++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:
++
++.sp
++.nf
++.cc |
++mode            = LIST
++separator       = "|"
++main prompt     = "sqlite> "
++continue prompt = "   ...> "
++|cc .
++.sp
++.fi
++
++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.
++
++o All other command line options are processed.
++
++.SH SEE ALSO
++http://www.sqlcipher.net/
++.br
++The sqlite-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>.
diff --git a/debian/patches/series b/debian/patches/series
index 884882b..db259fd 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,3 +1,4 @@
 10-520466-libsqlite3-depends-on-libdl.patch
 10-520478-squash-bad-deps.patch
 20-change-name-to-sqlcipher.patch
+10-sqlcipher-man-page.patch
diff --git a/debian/sqlcipher.manpages b/debian/sqlcipher.manpages
new file mode 100644
index 0000000..245b050
--- /dev/null
+++ b/debian/sqlcipher.manpages
@@ -0,0 +1 @@
+sqlcipher.1