source: branches/mbutscher/work/WikidPadHelp/data/CommandLineSupport.wiki @ 195

Last change on this file since 195 was 178, checked in by mbutscher, 11 years ago

2.0preAlpha (internal)

Works so far, now editing help wiki.

File size: 2.5 KB
Line 
1++ Command Line Support
2
3+++ Old form
4
5You can have up to two command line parameters, without leading '-'
6which have the following meaning:
7
8*First parameter* can be a path to a .wiki file (either a text file with
9wiki page content (this page is opened then) or the wiki configuration
10file). Instead of a path it can also be an URL with wiki: protocol
11
12*Second parameter* can be the name of a wiki word to open, if not
13specified in the first parameter.
14
15
16+++ New form
17
18You can specify switches and/or parameters on the command line where
19the names of the switches either consist of a '-' and a character
20(short form, e.g. "-h") or begin with two dashes and a name (long
21form, e.g. "--help").
22
23Some switches also take a parameter which must follow the switch on
24the command line.
25
26The following list of switches shows the short form (not present for
27all options), the long form and (if necessary) the meaning of the
28parameter in angle brackets:
29
30
31++++ General
32
33*-h, --help*
34Shows a message box with a short overview of available switches.
35
36*-w, --wiki  <wiki path>*
37Set the wiki to open on startup (same as first parameter of old form).
38
39*-p, --page <page name>*
40Set the page to open on startup (same as second parameter of old form). You can repeat this parameter multiple times to open multiple tabs.
41
42*--rebuild*
43Rebuild the opened wiki.
44
45*-x, --exit*
46Exit immediately after command line actions were completed.
47
48
49++++ Exporting
50
51The following three must all be specified if you want to export
52something, the fourth (--export-compfn) is optional:
53
54*--export-what <what>*
55Choose if you want to export *page*, *subtree* or *wiki*.
56
57*--export-type <type>*
58Tag of the export type. Currently this can be:
59
60    * html_single: Single HTML page
61    * html_multi: Set of HTML pages
62    * xml: XML output
63    * raw_files: Set of \*.wiki files in UTF-8 format with BOM
64
65*--export-dest <destination path>*
66Path of destination directory for export.
67
68
69*--export-compfn*
70Use compatible filenames on export.
71
72
73++++ Special
74
75*--deleteconfig*
76If this is the only switch on the command line, the program deletes
77(*without further request!*) the configuration files which are the
78main "WikidPad.config" file as well as everything in
79".WikidPadGlobals" directory (normally only the global text blocks
80file).
81
82After that the program terminates immediately (otherwise the files
83would be recreated).
84
85This switch is mainly used for the uninstalling of a Windows binary.
86The uninstaller *will* ask before running WikidPad with this option.
87
Note: See TracBrowser for help on using the repository browser.