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: * Keep an archive of notes * Keep a daily or weekly
32       journal  * Take notes during meetings or lectures * Organize task lists
33       * Draft blog entries and emails * Do brainstorming
34

OPTIONS

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

AUTHOR

82       Jaap Karssenberg <jaap.karssenberg@gmail.com>
83
84

SEE ALSO

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