poppler 2.2.4-x64-mingw32
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README +35 -0
- data/Rakefile +75 -0
- data/ext/poppler/depend +6 -0
- data/ext/poppler/extconf.rb +70 -0
- data/ext/poppler/poppler.def +2 -0
- data/ext/poppler/rbpoppler-action.c +372 -0
- data/ext/poppler/rbpoppler-annotation-callout-line.c +127 -0
- data/ext/poppler/rbpoppler-annotation-free-text.c +46 -0
- data/ext/poppler/rbpoppler-annotation-mapping.c +72 -0
- data/ext/poppler/rbpoppler-annotation-markup.c +98 -0
- data/ext/poppler/rbpoppler-annotation-text.c +53 -0
- data/ext/poppler/rbpoppler-annotation.c +74 -0
- data/ext/poppler/rbpoppler-attachment.c +124 -0
- data/ext/poppler/rbpoppler-button-field.c +56 -0
- data/ext/poppler/rbpoppler-choice-field.c +131 -0
- data/ext/poppler/rbpoppler-color.c +107 -0
- data/ext/poppler/rbpoppler-document.c +224 -0
- data/ext/poppler/rbpoppler-font-info.c +59 -0
- data/ext/poppler/rbpoppler-fonts-iter.c +127 -0
- data/ext/poppler/rbpoppler-form-field-mapping.c +44 -0
- data/ext/poppler/rbpoppler-form-field.c +98 -0
- data/ext/poppler/rbpoppler-image-mapping.c +48 -0
- data/ext/poppler/rbpoppler-index-iter.c +128 -0
- data/ext/poppler/rbpoppler-link-mapping.c +47 -0
- data/ext/poppler/rbpoppler-page-transition.c +59 -0
- data/ext/poppler/rbpoppler-page.c +322 -0
- data/ext/poppler/rbpoppler-private.h +77 -0
- data/ext/poppler/rbpoppler-ps-file.c +66 -0
- data/ext/poppler/rbpoppler-rectangle.c +92 -0
- data/ext/poppler/rbpoppler-text-field.c +91 -0
- data/ext/poppler/rbpoppler.c +111 -0
- data/ext/poppler/rbpoppler.h +61 -0
- data/ext/poppler/rbpopplerconversions.h +105 -0
- data/extconf.rb +49 -0
- data/lib/2.0/poppler.so +0 -0
- data/lib/2.1/poppler.so +0 -0
- data/lib/2.2/poppler.so +0 -0
- data/lib/poppler.rb +105 -0
- data/sample/number-pdf.rb +32 -0
- data/sample/pdf2.rb +132 -0
- data/sample/pdf2svg.rb +26 -0
- data/sample/pdf2text.rb +16 -0
- data/sample/pdfcrop.rb +32 -0
- data/sample/pdfdiv.rb +36 -0
- data/test/fixtures/image.pdf +0 -0
- data/test/fixtures/image.png +0 -0
- data/test/poppler-test-utils.rb +58 -0
- data/test/run-test.rb +32 -0
- data/test/test_annotation.rb +86 -0
- data/test/test_color.rb +26 -0
- data/test/test_constants.rb +30 -0
- data/test/test_document.rb +41 -0
- data/test/test_page.rb +42 -0
- data/vendor/local/bin/cjpeg.exe +0 -0
- data/vendor/local/bin/djpeg.exe +0 -0
- data/vendor/local/bin/jpegtran.exe +0 -0
- data/vendor/local/bin/libjpeg-9.dll +0 -0
- data/vendor/local/bin/libpoppler-48.dll +0 -0
- data/vendor/local/bin/libpoppler-cpp-0.dll +0 -0
- data/vendor/local/bin/libpoppler-glib-8.dll +0 -0
- data/vendor/local/bin/libsqlite3-0.dll +0 -0
- data/vendor/local/bin/pdfdetach.exe +0 -0
- data/vendor/local/bin/pdffonts.exe +0 -0
- data/vendor/local/bin/pdfimages.exe +0 -0
- data/vendor/local/bin/pdfinfo.exe +0 -0
- data/vendor/local/bin/pdfseparate.exe +0 -0
- data/vendor/local/bin/pdftocairo.exe +0 -0
- data/vendor/local/bin/pdftohtml.exe +0 -0
- data/vendor/local/bin/pdftoppm.exe +0 -0
- data/vendor/local/bin/pdftops.exe +0 -0
- data/vendor/local/bin/pdftotext.exe +0 -0
- data/vendor/local/bin/pdfunite.exe +0 -0
- data/vendor/local/bin/rdjpgcom.exe +0 -0
- data/vendor/local/bin/sqlite3.exe +0 -0
- data/vendor/local/bin/wrjpgcom.exe +0 -0
- data/vendor/local/include/jconfig.h +60 -0
- data/vendor/local/include/jerror.h +304 -0
- data/vendor/local/include/jmorecfg.h +446 -0
- data/vendor/local/include/jpeglib.h +1180 -0
- data/vendor/local/include/poppler/cpp/poppler-document.h +104 -0
- data/vendor/local/include/poppler/cpp/poppler-embedded-file.h +55 -0
- data/vendor/local/include/poppler/cpp/poppler-font.h +91 -0
- data/vendor/local/include/poppler/cpp/poppler-global.h +111 -0
- data/vendor/local/include/poppler/cpp/poppler-image.h +71 -0
- data/vendor/local/include/poppler/cpp/poppler-page-renderer.h +66 -0
- data/vendor/local/include/poppler/cpp/poppler-page-transition.h +82 -0
- data/vendor/local/include/poppler/cpp/poppler-page.h +76 -0
- data/vendor/local/include/poppler/cpp/poppler-rectangle.h +84 -0
- data/vendor/local/include/poppler/cpp/poppler-toc.h +74 -0
- data/vendor/local/include/poppler/cpp/poppler-version.h +39 -0
- data/vendor/local/include/poppler/glib/poppler-action.h +316 -0
- data/vendor/local/include/poppler/glib/poppler-annot.h +296 -0
- data/vendor/local/include/poppler/glib/poppler-attachment.h +87 -0
- data/vendor/local/include/poppler/glib/poppler-date.h +30 -0
- data/vendor/local/include/poppler/glib/poppler-document.h +299 -0
- data/vendor/local/include/poppler/glib/poppler-enums.h +116 -0
- data/vendor/local/include/poppler/glib/poppler-features.h +88 -0
- data/vendor/local/include/poppler/glib/poppler-form-field.h +111 -0
- data/vendor/local/include/poppler/glib/poppler-layer.h +43 -0
- data/vendor/local/include/poppler/glib/poppler-media.h +73 -0
- data/vendor/local/include/poppler/glib/poppler-movie.h +42 -0
- data/vendor/local/include/poppler/glib/poppler-page.h +377 -0
- data/vendor/local/include/poppler/glib/poppler-structure-element.h +357 -0
- data/vendor/local/include/poppler/glib/poppler.h +250 -0
- data/vendor/local/include/sqlite3.h +7494 -0
- data/vendor/local/include/sqlite3ext.h +487 -0
- data/vendor/local/lib/girepository-1.0/Poppler-0.18.typelib +0 -0
- data/vendor/local/lib/libjpeg.a +0 -0
- data/vendor/local/lib/libjpeg.dll.a +0 -0
- data/vendor/local/lib/libjpeg.la +41 -0
- data/vendor/local/lib/libpoppler-cpp.a +0 -0
- data/vendor/local/lib/libpoppler-cpp.dll.a +0 -0
- data/vendor/local/lib/libpoppler-cpp.la +41 -0
- data/vendor/local/lib/libpoppler-glib.a +0 -0
- data/vendor/local/lib/libpoppler-glib.dll.a +0 -0
- data/vendor/local/lib/libpoppler-glib.la +41 -0
- data/vendor/local/lib/libpoppler.a +0 -0
- data/vendor/local/lib/libpoppler.dll.a +0 -0
- data/vendor/local/lib/libpoppler.la +41 -0
- data/vendor/local/lib/libsqlite3.a +0 -0
- data/vendor/local/lib/libsqlite3.dll.a +0 -0
- data/vendor/local/lib/libsqlite3.la +41 -0
- data/vendor/local/lib/pkgconfig/poppler-cairo.pc +9 -0
- data/vendor/local/lib/pkgconfig/poppler-cpp.pc +13 -0
- data/vendor/local/lib/pkgconfig/poppler-glib.pc +13 -0
- data/vendor/local/lib/pkgconfig/poppler-splash.pc +9 -0
- data/vendor/local/lib/pkgconfig/poppler.pc +11 -0
- data/vendor/local/lib/pkgconfig/sqlite3.pc +13 -0
- data/vendor/local/share/gir-1.0/Poppler-0.18.gir +8281 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerAnnot.html +3221 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerAttachment.html +267 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerDocument.html +3328 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerFormField.html +1403 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerLayer.html +307 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerMedia.html +381 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerMovie.html +197 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerPage.html +3002 -0
- data/vendor/local/share/gtk-doc/html/poppler/PopplerStructureElement.html +3781 -0
- data/vendor/local/share/gtk-doc/html/poppler/annotation-glossary.html +63 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-0-12.html +123 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-0-14.html +102 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-0-16.html +180 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-0-18.html +72 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-0-20.html +39 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-0-22.html +64 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-deprecated.html +39 -0
- data/vendor/local/share/gtk-doc/html/poppler/api-index-full.html +1830 -0
- data/vendor/local/share/gtk-doc/html/poppler/ch01.html +74 -0
- data/vendor/local/share/gtk-doc/html/poppler/home.png +0 -0
- data/vendor/local/share/gtk-doc/html/poppler/index.html +85 -0
- data/vendor/local/share/gtk-doc/html/poppler/index.sgml +557 -0
- data/vendor/local/share/gtk-doc/html/poppler/left-insensitive.png +0 -0
- data/vendor/local/share/gtk-doc/html/poppler/left.png +0 -0
- data/vendor/local/share/gtk-doc/html/poppler/poppler-PDF-Utility-functions.html +107 -0
- data/vendor/local/share/gtk-doc/html/poppler/poppler-PopplerAction.html +796 -0
- data/vendor/local/share/gtk-doc/html/poppler/poppler-PopplerColor.html +201 -0
- data/vendor/local/share/gtk-doc/html/poppler/poppler-Version-and-Features-Information.html +254 -0
- data/vendor/local/share/gtk-doc/html/poppler/poppler-poppler.html +169 -0
- data/vendor/local/share/gtk-doc/html/poppler/poppler.devhelp2 +470 -0
- data/vendor/local/share/gtk-doc/html/poppler/right-insensitive.png +0 -0
- data/vendor/local/share/gtk-doc/html/poppler/right.png +0 -0
- data/vendor/local/share/gtk-doc/html/poppler/style.css +476 -0
- data/vendor/local/share/gtk-doc/html/poppler/up-insensitive.png +0 -0
- data/vendor/local/share/gtk-doc/html/poppler/up.png +0 -0
- data/vendor/local/share/license/poppler/AUTHORS +5 -0
- data/vendor/local/share/license/poppler/COPYING +339 -0
- data/vendor/local/share/man/man1/cjpeg.1 +387 -0
- data/vendor/local/share/man/man1/djpeg.1 +252 -0
- data/vendor/local/share/man/man1/jpegtran.1 +293 -0
- data/vendor/local/share/man/man1/pdfdetach.1 +86 -0
- data/vendor/local/share/man/man1/pdffonts.1 +119 -0
- data/vendor/local/share/man/man1/pdfimages.1 +260 -0
- data/vendor/local/share/man/man1/pdfinfo.1 +152 -0
- data/vendor/local/share/man/man1/pdfseparate.1 +49 -0
- data/vendor/local/share/man/man1/pdftocairo.1 +295 -0
- data/vendor/local/share/man/man1/pdftohtml.1 +107 -0
- data/vendor/local/share/man/man1/pdftoppm.1 +170 -0
- data/vendor/local/share/man/man1/pdftops.1 +217 -0
- data/vendor/local/share/man/man1/pdftotext.1 +137 -0
- data/vendor/local/share/man/man1/pdfunite.1 +33 -0
- data/vendor/local/share/man/man1/rdjpgcom.1 +63 -0
- data/vendor/local/share/man/man1/sqlite3.1 +279 -0
- data/vendor/local/share/man/man1/wrjpgcom.1 +103 -0
- metadata +254 -0
@@ -0,0 +1,137 @@
|
|
1
|
+
.\" Copyright 1997-2011 Glyph & Cog, LLC
|
2
|
+
.TH pdftotext 1 "15 August 2011"
|
3
|
+
.SH NAME
|
4
|
+
pdftotext \- Portable Document Format (PDF) to text converter
|
5
|
+
(version 3.03)
|
6
|
+
.SH SYNOPSIS
|
7
|
+
.B pdftotext
|
8
|
+
[options]
|
9
|
+
.RI [ PDF-file
|
10
|
+
.RI [ text-file ]]
|
11
|
+
.SH DESCRIPTION
|
12
|
+
.B Pdftotext
|
13
|
+
converts Portable Document Format (PDF) files to plain text.
|
14
|
+
.PP
|
15
|
+
Pdftotext reads the PDF file,
|
16
|
+
.IR PDF-file ,
|
17
|
+
and writes a text file,
|
18
|
+
.IR text-file .
|
19
|
+
If
|
20
|
+
.I text-file
|
21
|
+
is not specified, pdftotext converts
|
22
|
+
.I file.pdf
|
23
|
+
to
|
24
|
+
.IR file.txt .
|
25
|
+
If
|
26
|
+
.I text-file
|
27
|
+
is \'-', the text is sent to stdout.
|
28
|
+
.SH OPTIONS
|
29
|
+
.TP
|
30
|
+
.BI \-f " number"
|
31
|
+
Specifies the first page to convert.
|
32
|
+
.TP
|
33
|
+
.BI \-l " number"
|
34
|
+
Specifies the last page to convert.
|
35
|
+
.TP
|
36
|
+
.BI \-r " number"
|
37
|
+
Specifies the resolution, in DPI. The default is 72 DPI.
|
38
|
+
.TP
|
39
|
+
.BI \-x " number"
|
40
|
+
Specifies the x-coordinate of the crop area top left corner
|
41
|
+
.TP
|
42
|
+
.BI \-y " number"
|
43
|
+
Specifies the y-coordinate of the crop area top left corner
|
44
|
+
.TP
|
45
|
+
.BI \-W " number"
|
46
|
+
Specifies the width of crop area in pixels (default is 0)
|
47
|
+
.TP
|
48
|
+
.BI \-H " number"
|
49
|
+
Specifies the height of crop area in pixels (default is 0)
|
50
|
+
.TP
|
51
|
+
.B \-layout
|
52
|
+
Maintain (as best as possible) the original physical layout of the
|
53
|
+
text. The default is to \'undo' physical layout (columns,
|
54
|
+
hyphenation, etc.) and output the text in reading order.
|
55
|
+
.TP
|
56
|
+
.BI \-fixed " number"
|
57
|
+
Assume fixed-pitch (or tabular) text, with the specified character
|
58
|
+
width (in points). This forces physical layout mode.
|
59
|
+
.TP
|
60
|
+
.B \-raw
|
61
|
+
Keep the text in content stream order. This is a hack which often
|
62
|
+
"undoes" column formatting, etc. Use of raw mode is no longer
|
63
|
+
recommended.
|
64
|
+
.TP
|
65
|
+
.B \-htmlmeta
|
66
|
+
Generate a simple HTML file, including the meta information. This
|
67
|
+
simply wraps the text in <pre> and </pre> and prepends the meta
|
68
|
+
headers.
|
69
|
+
.TP
|
70
|
+
.B \-bbox
|
71
|
+
Generate an XHTML file containing bounding box information for each
|
72
|
+
word in the file.
|
73
|
+
.TP
|
74
|
+
.BI \-enc " encoding-name"
|
75
|
+
Sets the encoding to use for text output. This defaults to "UTF-8".
|
76
|
+
.TP
|
77
|
+
.B \-listenc
|
78
|
+
Lits the available encodings
|
79
|
+
.TP
|
80
|
+
.BI \-eol " unix | dos | mac"
|
81
|
+
Sets the end-of-line convention to use for text output.
|
82
|
+
.TP
|
83
|
+
.B \-nopgbrk
|
84
|
+
Don't insert page breaks (form feed characters) between pages.
|
85
|
+
.TP
|
86
|
+
.BI \-opw " password"
|
87
|
+
Specify the owner password for the PDF file. Providing this will
|
88
|
+
bypass all security restrictions.
|
89
|
+
.TP
|
90
|
+
.BI \-upw " password"
|
91
|
+
Specify the user password for the PDF file.
|
92
|
+
.TP
|
93
|
+
.B \-q
|
94
|
+
Don't print any messages or errors.
|
95
|
+
.TP
|
96
|
+
.B \-v
|
97
|
+
Print copyright and version information.
|
98
|
+
.TP
|
99
|
+
.B \-h
|
100
|
+
Print usage information.
|
101
|
+
.RB ( \-help
|
102
|
+
and
|
103
|
+
.B \-\-help
|
104
|
+
are equivalent.)
|
105
|
+
.SH BUGS
|
106
|
+
Some PDF files contain fonts whose encodings have been mangled beyond
|
107
|
+
recognition. There is no way (short of OCR) to extract text from
|
108
|
+
these files.
|
109
|
+
.SH EXIT CODES
|
110
|
+
The Xpdf tools use the following exit codes:
|
111
|
+
.TP
|
112
|
+
0
|
113
|
+
No error.
|
114
|
+
.TP
|
115
|
+
1
|
116
|
+
Error opening a PDF file.
|
117
|
+
.TP
|
118
|
+
2
|
119
|
+
Error opening an output file.
|
120
|
+
.TP
|
121
|
+
3
|
122
|
+
Error related to PDF permissions.
|
123
|
+
.TP
|
124
|
+
99
|
125
|
+
Other error.
|
126
|
+
.SH AUTHOR
|
127
|
+
The pdftotext software and documentation are copyright 1996-2011 Glyph
|
128
|
+
& Cog, LLC.
|
129
|
+
.SH "SEE ALSO"
|
130
|
+
.BR pdfdetach (1),
|
131
|
+
.BR pdffonts (1),
|
132
|
+
.BR pdfimages (1),
|
133
|
+
.BR pdfinfo (1),
|
134
|
+
.BR pdftocairo (1),
|
135
|
+
.BR pdftohtml (1),
|
136
|
+
.BR pdftoppm (1),
|
137
|
+
.BR pdftops (1)
|
@@ -0,0 +1,33 @@
|
|
1
|
+
.\" Copyright 2011 The Poppler Developers - http://poppler.freedesktop.org
|
2
|
+
.TH pdfunite 1 "15 September 2011"
|
3
|
+
.SH NAME
|
4
|
+
pdfunite \- Portable Document Format (PDF) page merger
|
5
|
+
.SH SYNOPSIS
|
6
|
+
.B pdfunite
|
7
|
+
[options]
|
8
|
+
.I PDF-sourcefile1..PDF-sourcefilen PDF-destfile
|
9
|
+
.SH DESCRIPTION
|
10
|
+
.B pdfunite
|
11
|
+
merges several PDF (Portable Document Format) files in order of their occurence on command line to one PDF result file.
|
12
|
+
.TP
|
13
|
+
Neither of the PDF-sourcefile1 to PDF-sourcefilen should be encrypted.
|
14
|
+
.SH OPTIONS
|
15
|
+
.TP
|
16
|
+
.B \-v
|
17
|
+
Print copyright and version information.
|
18
|
+
.TP
|
19
|
+
.B \-h
|
20
|
+
Print usage information.
|
21
|
+
.RB ( \-help
|
22
|
+
and
|
23
|
+
.B \-\-help
|
24
|
+
are equivalent.)
|
25
|
+
.SH EXAMPLE
|
26
|
+
pdfunite sample1.pdf sample2.pdf sample.pdf
|
27
|
+
.TP
|
28
|
+
merges all pages from sample1.pdf and sample2.pdf (in that order) and creates sample.pdf
|
29
|
+
.SH AUTHOR
|
30
|
+
The pdfunite software and documentation are copyright 1996-2004 Glyph & Cog, LLC
|
31
|
+
and copyright 2005-2011 The Poppler Developers - http://poppler.freedesktop.org
|
32
|
+
.SH "SEE ALSO"
|
33
|
+
.BR pdfseparate (1),
|
@@ -0,0 +1,63 @@
|
|
1
|
+
.TH RDJPGCOM 1 "13 September 2013"
|
2
|
+
.SH NAME
|
3
|
+
rdjpgcom \- display text comments from a JPEG file
|
4
|
+
.SH SYNOPSIS
|
5
|
+
.B rdjpgcom
|
6
|
+
[
|
7
|
+
.B \-raw
|
8
|
+
]
|
9
|
+
[
|
10
|
+
.B \-verbose
|
11
|
+
]
|
12
|
+
[
|
13
|
+
.I filename
|
14
|
+
]
|
15
|
+
.LP
|
16
|
+
.SH DESCRIPTION
|
17
|
+
.LP
|
18
|
+
.B rdjpgcom
|
19
|
+
reads the named JPEG/JFIF file, or the standard input if no file is named,
|
20
|
+
and prints any text comments found in the file on the standard output.
|
21
|
+
.PP
|
22
|
+
The JPEG standard allows "comment" (COM) blocks to occur within a JPEG file.
|
23
|
+
Although the standard doesn't actually define what COM blocks are for, they
|
24
|
+
are widely used to hold user-supplied text strings. This lets you add
|
25
|
+
annotations, titles, index terms, etc to your JPEG files, and later retrieve
|
26
|
+
them as text. COM blocks do not interfere with the image stored in the JPEG
|
27
|
+
file. The maximum size of a COM block is 64K, but you can have as many of
|
28
|
+
them as you like in one JPEG file.
|
29
|
+
.SH OPTIONS
|
30
|
+
.TP
|
31
|
+
.B \-raw
|
32
|
+
Normally
|
33
|
+
.B rdjpgcom
|
34
|
+
escapes non-printable characters in comments, for security reasons.
|
35
|
+
This option avoids that.
|
36
|
+
.PP
|
37
|
+
.B \-verbose
|
38
|
+
Causes
|
39
|
+
.B rdjpgcom
|
40
|
+
to also display the JPEG image dimensions.
|
41
|
+
.PP
|
42
|
+
Switch names may be abbreviated, and are not case sensitive.
|
43
|
+
.SH HINTS
|
44
|
+
.B rdjpgcom
|
45
|
+
does not depend on the IJG JPEG library. Its source code is intended as an
|
46
|
+
illustration of the minimum amount of code required to parse a JPEG file
|
47
|
+
header correctly.
|
48
|
+
.PP
|
49
|
+
In
|
50
|
+
.B \-verbose
|
51
|
+
mode,
|
52
|
+
.B rdjpgcom
|
53
|
+
will also attempt to print the contents of any "APP12" markers as text.
|
54
|
+
Some digital cameras produce APP12 markers containing useful textual
|
55
|
+
information. If you like, you can modify the source code to print
|
56
|
+
other APPn marker types as well.
|
57
|
+
.SH SEE ALSO
|
58
|
+
.BR cjpeg (1),
|
59
|
+
.BR djpeg (1),
|
60
|
+
.BR jpegtran (1),
|
61
|
+
.BR wrjpgcom (1)
|
62
|
+
.SH AUTHOR
|
63
|
+
Independent JPEG Group
|
@@ -0,0 +1,279 @@
|
|
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 SQLITE3 1 "Mon Jan 31 11:14:00 2014"
|
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 sqlite3
|
20
|
+
\- A command line interface for SQLite version 3
|
21
|
+
|
22
|
+
.SH SYNOPSIS
|
23
|
+
.B sqlite3
|
24
|
+
.RI [ options ]
|
25
|
+
.RI [ databasefile ]
|
26
|
+
.RI [ SQL ]
|
27
|
+
|
28
|
+
.SH SUMMARY
|
29
|
+
.PP
|
30
|
+
.B sqlite3
|
31
|
+
is a terminal-based front-end to the SQLite library that can evaluate
|
32
|
+
queries interactively and display the results in multiple formats.
|
33
|
+
.B sqlite3
|
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 sqlite3
|
40
|
+
interactive session, invoke the
|
41
|
+
.B sqlite3
|
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 sqlite3 mydata.db
|
51
|
+
.br
|
52
|
+
SQLite version 3.8.3
|
53
|
+
.br
|
54
|
+
Enter ".help" for instructions
|
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 sqlite3 -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
|
+
.cc |
|
111
|
+
.backup ?DB? FILE Backup DB (default "main") to FILE
|
112
|
+
.bail ON|OFF Stop after hitting an error. Default OFF
|
113
|
+
.databases List names and files of attached databases
|
114
|
+
.dump ?TABLE? ... Dump the database in an SQL text format
|
115
|
+
If TABLE specified, only dump tables matching
|
116
|
+
LIKE pattern TABLE.
|
117
|
+
.echo ON|OFF Turn command echo on or off
|
118
|
+
.exit Exit this program
|
119
|
+
.explain ?ON|OFF? Turn output mode suitable for EXPLAIN on or off.
|
120
|
+
With no args, it turns EXPLAIN on.
|
121
|
+
.header(s) ON|OFF Turn display of headers on or off
|
122
|
+
.help Show this message
|
123
|
+
.import FILE TABLE Import data from FILE into TABLE
|
124
|
+
.indices ?TABLE? Show names of all indices
|
125
|
+
If TABLE specified, only show indices for tables
|
126
|
+
matching LIKE pattern TABLE.
|
127
|
+
.load FILE ?ENTRY? Load an extension library
|
128
|
+
.log FILE|off Turn logging on or off. FILE can be stderr/stdout
|
129
|
+
.mode MODE ?TABLE? Set output mode where MODE is one of:
|
130
|
+
csv Comma-separated values
|
131
|
+
column Left-aligned columns. (See .width)
|
132
|
+
html HTML <table> code
|
133
|
+
insert SQL insert statements for TABLE
|
134
|
+
line One value per line
|
135
|
+
list Values delimited by .separator string
|
136
|
+
tabs Tab-separated values
|
137
|
+
tcl TCL list elements
|
138
|
+
.nullvalue STRING Use STRING in place of NULL values
|
139
|
+
.open ?FILENAME? Close existing database and reopen FILENAME
|
140
|
+
.output FILENAME Send output to FILENAME
|
141
|
+
.output stdout Send output to the screen
|
142
|
+
.print STRING... Print literal STRING
|
143
|
+
.prompt MAIN CONTINUE Replace the standard prompts
|
144
|
+
.quit Exit this program
|
145
|
+
.read FILENAME Execute SQL in FILENAME
|
146
|
+
.restore ?DB? FILE Restore content of DB (default "main") from FILE
|
147
|
+
.schema ?TABLE? Show the CREATE statements
|
148
|
+
If TABLE specified, only show tables matching
|
149
|
+
LIKE pattern TABLE.
|
150
|
+
.separator STRING Change separator used by output mode and .import
|
151
|
+
.show Show the current values for various settings
|
152
|
+
.stats ON|OFF Turn stats on or off
|
153
|
+
.tables ?TABLE? List names of tables
|
154
|
+
If TABLE specified, only list tables matching
|
155
|
+
LIKE pattern TABLE.
|
156
|
+
.timeout MS Try opening locked tables for MS milliseconds
|
157
|
+
.trace FILE|off Output each SQL statement as it is run
|
158
|
+
.vfsname ?AUX? Print the name of the VFS stack
|
159
|
+
.width NUM1 NUM2 ... Set column widths for "column" mode
|
160
|
+
.timer ON|OFF Turn the CPU timer measurement on or off
|
161
|
+
sqlite>
|
162
|
+
|cc .
|
163
|
+
.sp
|
164
|
+
.fi
|
165
|
+
.SH OPTIONS
|
166
|
+
.B sqlite3
|
167
|
+
has the following options:
|
168
|
+
.TP
|
169
|
+
.B \-bail
|
170
|
+
Stop after hitting an error.
|
171
|
+
.TP
|
172
|
+
.B \-batch
|
173
|
+
Force batch I/O.
|
174
|
+
.TP
|
175
|
+
.B \-column
|
176
|
+
Query results will be displayed in a table like form, using
|
177
|
+
whitespace characters to separate the columns and align the
|
178
|
+
output.
|
179
|
+
.TP
|
180
|
+
.BI \-cmd\ command
|
181
|
+
run
|
182
|
+
.I command
|
183
|
+
before reading stdin
|
184
|
+
.TP
|
185
|
+
.B \-csv
|
186
|
+
Set output mode to CSV (comma separated values).
|
187
|
+
.TP
|
188
|
+
.B \-echo
|
189
|
+
Print commands before execution.
|
190
|
+
.TP
|
191
|
+
.BI \-init\ file
|
192
|
+
Read and execute commands from
|
193
|
+
.I file
|
194
|
+
, which can contain a mix of SQL statements and meta-commands.
|
195
|
+
.TP
|
196
|
+
.B \-[no]header
|
197
|
+
Turn headers on or off.
|
198
|
+
.TP
|
199
|
+
.B \-help
|
200
|
+
Show help on options and exit.
|
201
|
+
.TP
|
202
|
+
.B \-html
|
203
|
+
Query results will be output as simple HTML tables.
|
204
|
+
.TP
|
205
|
+
.B \-interactive
|
206
|
+
Force interactive I/O.
|
207
|
+
.TP
|
208
|
+
.B \-line
|
209
|
+
Query results will be displayed with one value per line, rows
|
210
|
+
separated by a blank line. Designed to be easily parsed by
|
211
|
+
scripts or other programs
|
212
|
+
.TP
|
213
|
+
.B \-list
|
214
|
+
Query results will be displayed with the separator (|, by default)
|
215
|
+
character between each field value. The default.
|
216
|
+
.TP
|
217
|
+
.BI \-mmap\ N
|
218
|
+
Set default mmap size to
|
219
|
+
.I N
|
220
|
+
\.
|
221
|
+
.TP
|
222
|
+
.BI \-nullvalue\ string
|
223
|
+
Set string used to represent NULL values. Default is ''
|
224
|
+
(empty string).
|
225
|
+
.TP
|
226
|
+
.BI \-separator\ separator
|
227
|
+
Set output field separator. Default is '|'.
|
228
|
+
.TP
|
229
|
+
.B \-stats
|
230
|
+
Print memory stats before each finalize.
|
231
|
+
.TP
|
232
|
+
.B \-version
|
233
|
+
Show SQLite version.
|
234
|
+
.TP
|
235
|
+
.BI \-vfs\ name
|
236
|
+
Use
|
237
|
+
.I name
|
238
|
+
as the default VFS.
|
239
|
+
|
240
|
+
|
241
|
+
.SH INIT FILE
|
242
|
+
.B sqlite3
|
243
|
+
reads an initialization file to set the configuration of the
|
244
|
+
interactive environment. Throughout initialization, any previously
|
245
|
+
specified setting can be overridden. The sequence of initialization is
|
246
|
+
as follows:
|
247
|
+
|
248
|
+
o The default configuration is established as follows:
|
249
|
+
|
250
|
+
.sp
|
251
|
+
.nf
|
252
|
+
.cc |
|
253
|
+
mode = LIST
|
254
|
+
separator = "|"
|
255
|
+
main prompt = "sqlite> "
|
256
|
+
continue prompt = " ...> "
|
257
|
+
|cc .
|
258
|
+
.sp
|
259
|
+
.fi
|
260
|
+
|
261
|
+
o If the file
|
262
|
+
.B ~/.sqliterc
|
263
|
+
exists, it is processed first.
|
264
|
+
can be found in the user's home directory, it is
|
265
|
+
read and processed. It should generally only contain meta-commands.
|
266
|
+
|
267
|
+
o If the -init option is present, the specified file is processed.
|
268
|
+
|
269
|
+
o All other command line options are processed.
|
270
|
+
|
271
|
+
.SH SEE ALSO
|
272
|
+
http://www.sqlite.org/
|
273
|
+
.br
|
274
|
+
The sqlite3-doc package.
|
275
|
+
.SH AUTHOR
|
276
|
+
This manual page was originally written by Andreas Rottmann
|
277
|
+
<rotty@debian.org>, for the Debian GNU/Linux system (but may be used
|
278
|
+
by others). It was subsequently revised by Bill Bumgarner <bbum@mac.com> and
|
279
|
+
further updated by Laszlo Boszormenyi <gcs@debian.hu> .
|