sqlcipher.1

   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 "Thu Aug 31 12:00:00 EDT 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
  21
  22 .SH SYNOPSIS
  23 .B sqlcipher
  24 .RI [ options ]
  25 .RI [ databasefile ]
  26 .RI [ SQL ]
  27
  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.
  36
  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.
  45
  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 SQLite 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
  74
  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.
  80
  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.
  84
  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
  95
  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 (.).
 103
 104 A list of available meta-commands can be viewed at any time by issuing
 105 the '.help' command.  For example:
 106 .sp
 107 sqlite>
 108 .B .help
 109 .nf
 110 .tr %.
 111 ...
 112 .sp
 113 .fi
 114 <<<<<<< HEAD:sqlcipher.1
 115 .SH OPTIONS
 116 .B sqlcipher
 117 has the following options:
 118 .TP
 119 .B \-bail
 120 Stop after hitting an error.
 121 .TP
 122 .B \-batch
 123 Force batch I/O.
 124 .TP
 125 .B \-column
 126 Query results will be displayed in a table like form, using
 127 whitespace characters to separate the columns and align the
 128 output.
 129 .TP
 130 .BI \-cmd\  command
 131 run
 132 .I command
 133 before reading stdin
 134 .TP
 135 .B \-csv
 136 Set output mode to CSV (comma separated values).
 137 .TP
 138 .B \-echo
 139 Print commands before execution.
 140 .TP
 141 .BI \-init\  file
 142 Read and execute commands from
 143 .I file
 144 , which can contain a mix of SQL statements and meta-commands.
 145 .TP
 146 .B \-[no]header
 147 Turn headers on or off.
 148 .TP
 149 .B \-help
 150 Show help on options and exit.
 151 .TP
 152 .B \-html
 153 Query results will be output as simple HTML tables.
 154 .TP
 155 .B \-interactive
 156 Force interactive I/O.
 157 .TP
 158 .B \-line
 159 Query results will be displayed with one value per line, rows
 160 separated by a blank line.  Designed to be easily parsed by
 161 scripts or other programs
 162 .TP
 163 .B \-list
 164 Query results will be displayed with the separator (|, by default)
 165 character between each field value.  The default.
 166 .TP
 167 .BI \-mmap\  N
 168 Set default mmap size to
 169 .I N
 170 \.
 171 .TP
 172 .BI \-nullvalue\  string
 173 Set string used to represent NULL values.  Default is ''
 174 (empty string).
 175 .TP
 176 .BI \-separator\  separator
 177 Set output field separator.  Default is '|'.
 178 .TP
 179 .B \-stats
 180 Print memory stats before each finalize.
 181 .TP
 182 .B \-version
 183 Show SQLite version.
 184 .TP
 185 .BI \-vfs\  name
 186 Use
 187 .I name
 188 as the default VFS.
 189 =======
 190
 191 The available commands differ by version and build options, so they
 192 are not listed here. Please refer to your local copy for all available
 193 options.
 194 >>>>>>> sqlite-release:sqlite3.1
 195
 196
 197 .SH INIT FILE
 198 .B sqlcipher
 199 reads an initialization file to set the configuration of the
 200 interactive environment.  Throughout initialization, any previously
 201 specified setting can be overridden.  The sequence of initialization is
 202 as follows:
 203
 204 o The default configuration is established as follows:
 205
 206 .sp
 207 .nf
 208 .cc |
 209 mode            = LIST
 210 separator       = "|"
 211 main prompt     = "sqlite> "
 212 continue prompt = "   ...> "
 213 |cc .
 214 .sp
 215 .fi
 216
 217 o If the file
 218 .B ${XDG_CONFIG_HOME}/sqlite3/sqliterc
 219 or
 220 .B ~/.sqliterc
 221 exists, the first of those to be found is processed during startup.
 222 It should generally only contain meta-commands.
 223
 224 o If the -init option is present, the specified file is processed.
 225
 226 o All other command line options are processed.
 227
 228 .SH SEE ALSO
 229 <<<<<<< HEAD:sqlcipher.1
 230 https://www.zetetic.net/sqlcipher
 231 =======
 232 https://sqlite.org/cli.html
 233 .br
 234 https://sqlite.org/fiddle (a WebAssembly build of the CLI app)
 235 >>>>>>> sqlite-release:sqlite3.1
 236 .br
 237 The sqlite3-doc package.
 238 .SH AUTHOR
 239 This manual page was originally written by Andreas Rottmann
 240 <rotty@debian.org>, for the Debian GNU/Linux system (but may be used
 241 by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com>,
 242 Laszlo Boszormenyi <gcs@debian.hu>, and the sqlite3 developers.