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]]
11          or: zim --server [OPTIONS] [NOTEBOOK]
12          or: zim --export [OPTIONS] NOTEBOOK [PAGE]
13          or: zim --search NOTEBOOK QUERY
14          or: zim --index  NOTEBOOK
15          or: zim --plugin PLUGIN [ARGUMENTS]
16          or: zim --manual [OPTIONS] [PAGE]
17          or: zim --help
18
19

DESCRIPTION

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

OPTIONS

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

AUTHOR

84       Jaap Karssenberg <jaap.karssenberg@gmail.com>
85
86

SEE ALSO

88       The full documentation for zim is maintained as  a  zim  notebook.  The
89       command
90
91              zim --manual
92
93       should give you access to the complete manual.
94
95       The website for zim can be found at https://www.zim-wiki.org
96
97
98
99zim 0.74.3                       January 2022                           ZIM(1)