zim(1) - f37

1ZIM(1)                           User Commands                          ZIM(1)
2
3
4

NAME

6       zim - A Desktop Wiki Editor
7
8

SYNOPSIS

10       usage: zim [OPTIONS] [NOTEBOOK [PAGE_LINK]]
11          or: zim --gui [OPTIONS] [NOTEBOOK [PAGE_LINK]]
12          or: zim --server [OPTIONS] [NOTEBOOK]
13          or: zim --export [OPTIONS] NOTEBOOK [PAGE]
14          or: zim --search NOTEBOOK QUERY
15          or: zim --index  [OPTIONS] NOTEBOOK
16          or: zim --plugin PLUGIN [ARGUMENTS]
17          or: zim --manual [OPTIONS] [PAGE_LINK]
18          or: zim --help
19
20       NOTEBOOK  can be a local file path, a local file URI or a notebook name
21       PAGE is be a fully specified page name PAGE_LINK is a  fully  specified
22       page name optionally extended with an anchor ID
23
24

DESCRIPTION

26       Zim  is  a  graphical text editor used to maintain a collection of wiki
27       pages. Each page can contain links to other pages,  simple  formatting,
28       and  images.  Pages  are  stored in a folder structure, like in an out‐
29       liner, and can have attachments.  Creating a new page  is  as  easy  as
30       linking  to  a nonexistent page. All data is stored in plain text files
31       with wiki formatting. Various plugins provide additional functionality,
32       like  a task list manager, an equation editor, a tray icon, and support
33       for version control.
34
35
36       Zim can be used to:
37
38
39       •      Keep an archive of notes
40
41       •      Keep a daily or weekly journal
42
43       •      Take notes during meetings or lectures
44
45       •      Organize task lists
46
47       •      Draft blog entries and emails
48
49       •      Do brainstorming
50

OPTIONS

52       General Options:
53         --gui            run the editor (this is the default)
54         --server         run the web server
55         --export         export to a different format
56         --search         run a search query on a notebook
57         --index          build an index for a notebook
58         --plugin         call a specific plugin function
59         --manual         open the user manual
60         -V, --verbose    print information to terminal
61         -D, --debug      print debug messages
62         -v, --version    print version and exit
63         -h, --help       print this text
64
65       GUI Options:
66         --list           show the list with notebooks instead of
67                          opening the default notebook
68         --geometry       window size and position as WxH+X+Y
69         --fullscreen     start in fullscreen mode
70         --standalone     start a single instance, no background process
71
72       Server Options:
73         --port           port to use (defaults to 8080)
74         --template       name or filepath of the template to use
75         --private        serve only to localhost
76         --gui            run the gui wrapper for the server
77
78       Export Options:
79         -o, --output     output directory (mandatory option)
80         --format         format to use (defaults to 'html')
81         --template       name or filepath of the template to use
82         --root-url       url to use for the document root
83         --index-page     index page name
84         -r, --recursive  when exporting a page, also export sub-pages
85         -s, --singlefile export all pages to a single output file
86         -O, --overwrite  force overwriting existing file(s)
87
88       Search Options:
89         None
90
91       Index Options:
92         -f, --flush      flush the index first and force re-building
93
94       Try 'zim --manual' for more help.
95
96

AUTHOR

98       Jaap Karssenberg <jaap.karssenberg@gmail.com>
99
100

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

AUTHOR

SEE ALSO