downgrade memory unlock failures to info level and fix function name in log output
[sqlcipher.git] / sqlcipher.1
blobc9a310057d5cdcb5a4030dff042e8f905af5a2a7
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH SQLCIPHER 1 "Fri Aug 11 23:50:12 CET 2023"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 .B sqlcipher 
20 \- A command line interface for SQLCipher version 3
22 .SH SYNOPSIS
23 .B sqlcipher
24 .RI [ options ]
25 .RI [ databasefile ]
26 .RI [ SQL ]
28 .SH SUMMARY
29 .PP
30 .B sqlcipher
31 is a terminal-based front-end to the SQLCipher library that can evaluate
32 queries interactively and display the results in multiple formats.
33 .B sqlcipher
34 can also be used within shell scripts and other applications to provide
35 batch processing features.
37 .SH DESCRIPTION
38 To start a
39 .B sqlcipher
40 interactive session, invoke the
41 .B sqlcipher
42 command and optionally provide the name of a database file.  If the
43 database file does not exist, it will be created.  If the database file
44 does exist, it will be opened.
46 For example, to create a new database file named "mydata.db", create
47 a table named "memos" and insert a couple of records into that table:
48 .sp
49
50 .B sqlcipher mydata.db
51 .br
52 SQLCipher version 3.43.0 2023-08-11 17:45:23
53 .br
54 Enter ".help" for usage hints.
55 .br
56 sqlite>
57 .B create table memos(text, priority INTEGER);
58 .br
59 sqlite>
60 .B insert into memos values('deliver project description', 10);
61 .br
62 sqlite>
63 .B insert into memos values('lunch with Christine', 100);
64 .br
65 sqlite>
66 .B select * from memos;
67 .br
68 deliver project description|10
69 .br
70 lunch with Christine|100
71 .br
72 sqlite>
73 .sp
75 If no database name is supplied, the ATTACH sql command can be used
76 to attach to existing or create new database files.  ATTACH can also
77 be used to attach to multiple databases within the same interactive
78 session.  This is useful for migrating data between databases,
79 possibly changing the schema along the way.
81 Optionally, a SQL statement or set of SQL statements can be supplied as
82 a single argument.  Multiple statements should be separated by
83 semi-colons.
85 For example:
86 .sp
87
88 .B sqlcipher -line mydata.db 'select * from memos where priority > 20;'
89 .br
90     text = lunch with Christine
91 .br
92 priority = 100
93 .br
94 .sp
96 .SS SQLITE META-COMMANDS
97 .PP
98 The interactive interpreter offers a set of meta-commands that can be
99 used to control the output format, examine the currently attached
100 database files, or perform administrative operations upon the
101 attached databases (such as rebuilding indices).   Meta-commands are
102 always prefixed with a dot (.).
104 A list of available meta-commands can be viewed at any time by issuing
105 the '.help' command.  For example:
107 sqlite>
108 .B .help
110 .tr %.
115 The available commands differ by version and build options, so they
116 are not listed here. Please refer to your local copy for all available
117 options.
120 .SH INIT FILE
121 .B sqlcipher
122 reads an initialization file to set the configuration of the
123 interactive environment.  Throughout initialization, any previously
124 specified setting can be overridden.  The sequence of initialization is
125 as follows:
127 o The default configuration is established as follows:
131 .cc |
132 mode            = LIST
133 separator       = "|"
134 main prompt     = "sqlite> "
135 continue prompt = "   ...> "
136 |cc .
140 o If the file
141 .B ${XDG_CONFIG_HOME}/sqlcipher/sqliterc
143 .B ~/.sqliterc
144 exists, the first of those to be found is processed during startup.
145 It should generally only contain meta-commands.
147 o If the -init option is present, the specified file is processed.
149 o All other command line options are processed.
151 .SH SEE ALSO
152 https://zetetic.net/sqlcipher
155 The sqlcipher-doc package.
156 .SH AUTHOR
157 This manual page was originally written by Andreas Rottmann
158 <rotty@debian.org>, for the Debian GNU/Linux system (but may be used
159 by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com>,
160 Laszlo Boszormenyi <gcs@debian.hu>, and the sqlcipher developers.