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  [OPTIONS] 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         --index         build an index for a notebook
40         --plugin        call a specific plugin function
41         --manual        open the user manual
42         -V, --verbose   print information to terminal
43         -D, --debug     print debug messages
44         -v, --version   print version and exit
45         -h, --help      print this text
46
47       GUI Options:
48         --list          show the list with notebooks instead of
49                         opening the default notebook
50         --geometry      window size and position as WxH+X+Y
51         --fullscreen    start in fullscreen mode
52         --no-daemon     start a single instance, no daemon
53
54       Server Options:
55         --port          port to use (defaults to 8080)
56         --template      name of the template to use
57         --gui           run the gui wrapper for the server
58
59       Export Options:
60         --format        format to use (defaults to 'html')
61         --template      name of the template to use
62         -o, --output    output directory
63         --root-url      url to use for the document root
64         --index-page    index page name
65
66         You can use the export option to print a single page to stdout.
67         When exporting a whole notebook you need to provide a directory.
68
69       Search Options:
70         None
71
72       Index Options:
73         -o, --output    output file
74
75       Try 'zim --manual' for more help.
76
77

AUTHOR

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

SEE ALSO

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