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       Zim can be used to: * Keep an archive of  notes  *  Take  notes  during
31       meetings  or  lectures  *  Organize task lists * Draft blog entries and
32       emails * Do brainstorming
33

OPTIONS

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

AUTHOR

80       Jaap Karssenberg <jaap.karssenberg@gmail.com>
81
82

SEE ALSO

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