pdf viewer c# open source : Adding bookmarks to pdf document control Library platform web page asp.net azure web browser calibre23-part882

calibre User Manual, Release 2.56.0
1.10.5 Creating your own icon theme for calibre
If you have created a beautiful set of icons and wish to share them with other calibre users via calibre’s builtin icon
theme support, you can easily package up your icons into a theme. To do so, go to Preferences->Miscellaneous-
>Create icon theme, select the folderwhere you have putyour icons (usually the resources/images folderin the
calibre config directory, as described above). Then fill up the theme metadata and click OK. This will result in a zip
file containing the theme icons. You can upload that to the calibre forum atMobileread
96
and then I will make your
theme available via calibre’s builtin icon theme system.
1.10.6 Customizing calibre with plugins
calibre has a very modular design. Almost all functionality in calibre comes in the form of plugins. Plugins are used
for conversion,for downloading news (though these are called recipes), for various components of the user interface,
to connect to different devices, to process files when adding themto calibre and so on. You can get a complete list of
all the built-in plugins in calibre bygoing to Preferences->Plugins.
You can write your own plugins to customize and extend the behavior of calibre. The plugin architecture in calibre is
very simple, see the tutorialWritingyourownpluginstoextendcalibre’sfunctionality(page 169).
1.11 Command Line Interface
Note:
On OS X, the command line tools are inside the calibre bundle, for ex-
ample,
if you
installed
calibre
in
/Applications
the
command
line
tools are
in
/Applications/calibre.app/Contents/console.app/Contents/MacOS/.
1.11.1 Documented Commands
calibre
calibre [options] [path_to_ebook]
Launch the main calibre Graphical User Interface and optionally add the ebook at path_to_ebook to the database.
Whenever you pass arguments to calibre that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
[options]
--detach
Detach fromthe controllingterminal,if any (linux only)
--help, -h
show this help message and exit
--ignore-plugins
Ignore custom plugins, useful if you installeda plugin that is preventing calibre from starting
96
http://www.mobileread.com/forums/forumdisplay.php?f=166
1.11. Command Line Interface
227
Adding bookmarks to pdf document - add, remove, update PDF bookmarks in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your C# Project with Rapid PDF Internal Navigation Via Bookmark and Outline
how to bookmark a pdf page; bookmark pdf reader
Adding bookmarks to pdf document - VB.NET PDF bookmark library: add, remove, update PDF bookmarks in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your VB.NET Project with Rapid PDF Internal Navigation Via Bookmark and Outline
how to add bookmarks to pdf files; display bookmarks in pdf
calibre User Manual, Release 2.56.0
--no-update-check
Do not check for updates
--shutdown-running-calibre, -s
Cause a running calibre instance,ifany,tobe shutdown. Note that if thereare running jobs, they willbe silently
aborted, so use with care.
--start-in-tray
Start minimized to system tray.
--verbose, -v
Ignored,do not use. Present only forlegacy reasons
--version
show program’s version number and exit
--with-library
Use the librarylocated at the specified path.
calibre-customize
calibre-customize options
Customize calibre by loading external plugins.
Wheneveryou pass arguments to calibre-customize that have spaces in them, enclose the arguments in quota-
tion marks. Forexample “C:some path with spaces”
[options]
--add-plugin, -a
Add a plugin by specifying the path to the zip file containing it.
--build-plugin, -b
For plugin developers: Path to the directory where you are developing the plugin. This command will automat-
ically zip up the plugin and update it in calibre.
--customize-plugin
Customize plugin. Specify name of plugin and customization string separated by a comma.
--disable-plugin
Disable the named plugin
--enable-plugin
Enable the named plugin
--help, -h
show this help message and exit
--list-plugins, -l
List all installed plugins
--remove-plugin, -r
Remove a customplugin by name. Has no effect on builtin plugins
--version
show program’s version number and exit
228
Chapter 1. Sections
C# Create PDF Library SDK to convert PDF from other file formats
Create and save editable PDF with a blank page, bookmarks, links, signatures, etc. Besides, using this PDF document metadata adding control, you can
how to create bookmark in pdf with; create bookmarks in pdf from excel
.NET PDF SDK - Description of All PDF Processing Control Feastures
Full page navigation, zooming & rotation; Outlines, bookmarks, & thumbnail display; Support adding and inserting hyperlink (link) to PDF document; Allow to
create bookmarks pdf; creating bookmarks pdf files
calibre User Manual, Release 2.56.0
calibre-debug
calibre-debug [options]
Various command line interfaces useful for debugging calibre. With no options, this command starts an embedded
python interpreter. You can also run the main calibre GUI, the calibre viewer and the calibre editorin debug mode.
It also contains interfaces to various bits of calibre that do not have dedicated command line tools, such as font
subsetting, the ebook diff tool and so on.
You canalso use calibre-debug to run standalone scripts. To do that use it like this:
calibre-debug myscript.py -- –option1 –option2 file1 file2 ...
Everything after the -- is passed to the script.
Whenever you pass arguments to calibre-debug that have spaces in them, enclose the arguments in quotation
marks. Forexample “C:some path with spaces”
[options]
--add-simple-plugin
Add a simple plugin (i.e. a plugin that consists ofonly a .pyfile),by specifying the path tothe py file containing
the plugin code.
--command, -c
Run python code.
--debug-device-driver, -d
Debug device detection
--default-programs
(Un)register calibre from Windows Default Programs.
--default-programs (page 229) =
(register|unregister)
--diff
Run the calibre diff tool. For example: calibre-debug--diff (page 229) file1 file2
--edit-book, -t
Launch the calibre Edit Book tool in debug mode.
--exec-file, -e
Run the python code in file.
--explode-book, -x
Explode the book (exports the book as a collection of HTML files and metadata, which you can edit using
standardHTML editing tools, and then rebuilds the file fromthe editedHTML.Makes noadditional changes to
the HTML, unlike a full calibre conversion).
--gui, -g
Run the GUI with debugging enabled. Debug output is printed to stdout and stderr.
--gui-debug
Run the GUIwith a debug console, logging to the specified path. For internal use only, use the -g option to run
the GUI in debug mode
--help, -h
show this help message and exit
--inspect-mobi, -m
Inspect the MOBIfile(s) at the specified path(s)
1.11. Command Line Interface
229
calibre User Manual, Release 2.56.0
--new-server
Run the new calibre content server. Any options specified after a -- will be passed to the server.
--paths
Output the paths necessary to setup the calibre environment
--py-console, -p
Run python console
--reinitialize-db
Re-initialize the sqlite calibre database at the specified path. Useful to recover from db corruption.
--run-plugin, -r
Run a plugin that provides a command line interface. For example: calibre-debug -r "Add Books" -- file1
–option1 Everything after the -- will be passed to the plugin as arguments.
--shutdown-running-calibre, -s
Cause a running calibre instance,ifany,tobe shutdown. Note that if thereare running jobs, they willbe silently
aborted, so use with care.
--subset-font, -f
Subset the specified font. Use -- after this option to pass option to the font subsetting program.
--test-build
Test binary modules in build
--version
show program’s version number and exit
--viewer, -w
Run the ebook viewer in debug mode
calibre-server
calibre-server [options]
Start the calibre content server. The calibre content server exposes your calibre library over the internet. The default
interface allows youto browse youcalibre library bycategories. Youcan also access aninterface optimized formobile
browsers at /mobile and an OPDSbased interface foruse with reading applications at /opds.
The OPDSinterface is advertised via BonJour automatically.
Whenever you pass arguments to calibre-server that have spaces in them, enclose the arguments in quotation
marks. Forexample “C:some path with spaces”
[options]
--auto-reload
Auto reload server when source code changes. May not work in all environments.
--daemonize
Run process inbackground as a daemon. No effect on windows.
--develop
Development mode. Server automatically restarts on file changes and serves code files (html, css, js) from the
file system instead of calibre’s resource system.
--help, -h
show this help message and exit
230
Chapter 1. Sections
calibre User Manual, Release 2.56.0
--max-cover
The maximumsize for displayed covers. Default is ’600x800’.
--max-opds-items
The maximumnumberof matches to return per OPDS query. This affects Stanza, WordPlayer,etc. integration.
--max-opds-ungrouped-items
Group items in categories such as author/tags by first letter when there are more than this number of items.
Default: 100. Set to a large number to disable grouping.
--password
Set a password to restrict access. By default access is unrestricted.
--pidfile
Write process PID to the specified file
--port, -p
The port on which to listen. Default is 8080
--restriction
Specifies a virtual library to be used for this invocation. This option overrides any per-library settings specified
in the GUI. For compatibility, if the value is not a virtual library but is a saved search, that saved search is used.
Also note that if you do not specify a restriction, the value specified in the GUI (if any) will be used.
--thread-pool
The max numberof workerthreads to use. Default is 30
--timeout, -t
The server timeout in seconds. Default is 120
--url-prefix
Prefix to prepend to all URLs. Useful for reverseproxying to this server from Apache/nginx/etc.
--username
Username for access. By default, it is: ’calibre’
--version
show program’s version number and exit
--with-library
Path to the library folder to serve with the content server
calibre-smtp
calibre-smtp [options] [from to text]
Sendmail using the SMTP protocol. calibre-smtp has two modes of operation. In the composemode you specify
from to and text and these are used to build and send an email message. In the filter mode, calibre-smtp reads a
complete email message fromSTDIN and sends it.
text is the body of the email message. If text is not specified, a complete email message is read from STDIN. from
is the email address of the sender and to is the email address of the recipient. When a complete email is read from
STDIN, from and to are only used in the SMTPnegotiation, the message headers are not modified.
Whenever you pass arguments to calibre-smtp that have spaces in them, enclose the arguments in quotation
marks. Forexample “C:some path with spaces”
1.11. Command Line Interface
231
calibre User Manual, Release 2.56.0
[options]
--fork, -f
Fork and deliver message in background. If you use this option, you should also use--outbox (page 232) to
handle delivery failures.
--help, -h
show this help message and exit
--localhost, -l
Host name of localhost. Used when connecting toSMTPserver.
--outbox, -o
Path to maildirfolderto store failed email messages in.
--timeout, -t
Timeout for connection
--verbose, -v
Be more verbose
--version
show program’s version number and exit
COMPOSE MAIL Options to compose an email. Ignored iftext is not specified
--attachment, -a
File to attach to the email
--subject, -s
Subject of the email
SMTP RELAY Options to use an SMTP relay server to send mail. calibre will try to send the email directly unless
–relay is specified.
--encryption-method, -e
Encryptionmethod touse whenconnecting to relay. Choices are TLS,SSL andNONE.Default is TLS. WARN-
ING: Choosing NONE is highly insecure
--password, -p
Password for relay
--port
Port to connect to on relay server. Default is to use 465 if encryption method is SSL and 25 otherwise.
--relay, -r
An SMTP relay server to use to send mail.
--username, -u
Username for relay
calibredb
calibredb command [options] [arguments]
calibredb is the command line interface tothe calibre database. It has several sub-commands, documented below:
232
Chapter 1. Sections
calibre User Manual, Release 2.56.0
• GlobalOptions(page 233)
• list (page 233)
• add (page 234)
– AddingFromDirectories(page 235)
• remove (page 235)
• add_format(page 235)
• remove_format(page 236)
• show_metadata (page 236)
• set_metadata (page 236)
• export(page 236)
• catalog (page 237)
• saved_searches (page 238)
• add_custom_column (page 238)
• custom_columns(page 239)
• remove_custom_column (page 239)
• set_custom (page 239)
• restore_database (page 239)
• check_library (page 240)
• list_categories (page 240)
• backup_metadata (page 240)
• clone (page 241)
• embed_metadata (page 241)
• search (page 241)
Global Options
--dont-notify-gui
Do not notify the running calibre GUI (if any) that the database has changed. Use with care, as it can lead to
database corruption!
--help, -h
show this help message and exit
--library-path
Path to the calibre library. Default is touse the path stored in the settings.
--version
show program’s version number and exit
list
calibredb list [options]
List the books available in the calibre database.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
--ascending
Sort results in ascending order
--fields, -f
The fields to display when listing books in the database. Should be a comma separated list of fields. Available
1.11. Command Line Interface
233
calibre User Manual, Release 2.56.0
fields: author_sort, authors, comments, cover, formats, id, identifiers, isbn, languages, last_modified, pubdate,
publisher, rating, series, series_index, size, tags, timestamp, title, uuid Default: title,authors. The special field
"all" can be used to select all fields.
--for-machine
Generate output in JSON format, which is more suitable for machine parsing. Causes the line width and sepa-
rator options to be ignored.
--limit
The maximumnumberof results to display. Default: all
--line-width, -w
The maximumwidth ofa single line in the output. Defaults to detecting screen size.
--prefix
The prefixforall file paths. Default is the absolute path to the library folder.
--search, -s
Filterthe results by the searchquery. For the format of the search query,please see the search related documen-
tation in the UserManual. Default is to do nofiltering.
--separator
The string used to separate fields. Default is a space.
--sort-by
The field by which to sort the results. Available fields: author_sort, authors, comments, cover, formats, identi-
fiers, isbn, languages,last_modified, pubdate,publisher, rating, series, series_index,size, tags, timestamp, title,
uuid Default: id
add
calibredb add [options] file1 file2 file3 ...
Add the specified files as books to the database. You can also specify directories, see the directory related options
below.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
--authors, -a
Set the authors of the addedbook(s)
--cover, -c
Path to the cover to use for the added book
--duplicates, -d
Add books to database even iftheyalready exist. Comparisonis done based on book titles.
--empty, -e
Add an empty book (a book with no formats)
--identifier, -I
Set the identifiers forthis book, for e.g. -Iasin:XXX -I isbn:YYY
--isbn, -i
Set the ISBN of the added book(s)
--languages, -l
Acomma separated list of languages (best to use ISO639 language codes, though some language names may
also be recognized)
234
Chapter 1. Sections
calibre User Manual, Release 2.56.0
--series, -s
Set the series of the added book(s)
--series-index, -S
Set the series number of the added book(s)
--tags, -T
Set the tags of the added book(s)
--title, -t
Set the title ofthe added book(s)
Adding From Directories Options to control the adding of books from directories. By default only files that have
extensions of known e-book file types are added.
--add
Afilename (glob) pattern, files matching this pattern will be added when scanning directories for files, even if
they are not ofa known ebook file type. Can be specified multiple times for multiple patterns.
--ignore
Afilename (glob)pattern, files matching this pattern will be ignored when scanning directories forfiles. Canbe
specified multiple times formultiple patterns. For e.g.: *.pdf will ignore all pdf files
--one-book-per-directory, -1
Assume that each directory has only a single logical book and that all files in it are different e-book formats of
that book
--recurse, -r
Process directories recursively
remove
calibredb remove ids
Remove the books identified by ids from the database. ids should be a comma separated list of id numbers (you can
get id numbers by using the search command). For example, 23,34,57-85 (when specifying a range, the last number
in the range is not included).
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
add_format
calibredb add_format [options] id ebook_file
Add the ebook in ebook_file to the available formats for the logical book identified by id. You can get id by using the
search command. If the format already exists, it is replaced,unless the do not replace option is specified.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
--dont-replace
Do not replace the format ifit already exists
1.11. Command Line Interface
235
calibre User Manual, Release 2.56.0
remove_format
calibredb remove_format [options] id fmt
Remove the format fmt from the logical book identified by id. You can get id by using the search command. fmt
should be a file extension like LRF orTXT or EPUB.If the logical book does not have fmt available,do nothing.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
show_metadata
calibredb show_metadata [options] id
Show the metadata stored in the calibre database for the book identified by id. id is an id number from the search
command.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
--as-opf
Print metadata in OPF form (XML)
set_metadata
calibredb set_metadata [options] id [/path/to/metadata.opf]
Set the metadata stored in the calibre database for the book identified by id from the OPF file metadata.opf. id is an
id number from the search command. You can get a quick feel for the OPF format by using the –as-opf switch to the
show_metadata command. You can also set the metadata of individual fields with the –field option. If you use the
–field option,there is no need to specify an OPF file.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
--field, -f
The field to set. Format is field_name:value, for example: --field (page 236) tags:tag1,tag2. Use
--list-fields(page236)togetalistofallfieldnames. Youcanspecifythisoptionmultipletimesto
set multiple fields. Note: For languages you must use the ISO639 language codes (e.g. en for English, fr for
French and so on). For identifiers, the syntax is--field (page 236) identifiers:isbn:XXXX,doi:YYYYY. For
boolean (yes/no)fields use true and false or yes and no.
--list-fields, -l
List the metadata field names that can be used with the--field (page 236)option
export
calibredb export [options] ids
Export the books specified by ids (a comma separated list) to the filesystem. The export operation saves allformats
ofthe book,its coverand metadata (in an opf file). You can get id numbers from the search command.
Whenever you pass arguments to calibredb that have spaces in them, enclose the arguments in quotation marks. For
example “C:some path with spaces”
236
Chapter 1. Sections
Documents you may be interested
Documents you may be interested