GeezerVison is showing github.com — sqlcipher/sqlcipher.1 at master · mkomet/sqlcipher

Expand file tree

sqlcipher.1

Copy path

More file actions

Latest commit

History

242 lines (224 loc) · 5.83 KB

sqlcipher.1

Copy path

File metadata and controls

242 lines (224 loc) · 5.83 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

.\" 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 "Thu Aug 31 12:00:00 EDT 2023"

.\" 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 3

.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 3.43.0 2023-08-11 17:45:23

.br

Enter ".help" for usage hints.

.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

.tr %.

...

.sp

.fi

<<<<<<< HEAD:sqlcipher.1

.SH OPTIONS

.B sqlcipher

has the following options:

.TP

.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 \-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

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 \-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

.BI \-vfs\ name

Use

.I name

as the default VFS.

=======

The available commands differ by version and build options, so they

are not listed here. Please refer to your local copy for all available

options.

>>>>>>> sqlite-release:sqlite3.1

.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 ${XDG_CONFIG_HOME}/sqlite3/sqliterc

.B ~/.sqliterc

exists, the first of those to be found is processed during startup.

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

<<<<<<< HEAD:sqlcipher.1

https://www.zetetic.net/sqlcipher

=======

https://sqlite.org/cli.html

.br

https://sqlite.org/fiddle (a WebAssembly build of the CLI app)

>>>>>>> sqlite-release:sqlite3.1

.br

The sqlite3-doc package.

.SH AUTHOR

This manual page was originally written by Andreas Rottmann

<[email protected]>, for the Debian GNU/Linux system (but may be used

by others). It was subsequently revised by Bill Bumgarner <[email protected]>,

Laszlo Boszormenyi <[email protected]>, and the sqlite3 developers.