| 1 | [:page:PageHeader][:toc:]
|
|---|
| 2 | + Command Line Support
|
|---|
| 3 |
|
|---|
| 4 | ++ Old form
|
|---|
| 5 |
|
|---|
| 6 | You can have up to two command line parameters, without leading '-'
|
|---|
| 7 | which have the following meaning:
|
|---|
| 8 |
|
|---|
| 9 | +++++ First Parameter
|
|---|
| 10 | *First parameter* can be a path to a .wiki file (either a text file with
|
|---|
| 11 | WikiPage content (this page is opened then) or the wiki configuration
|
|---|
| 12 | file). Instead of a path it can also be an URL with wiki: protocol
|
|---|
| 13 |
|
|---|
| 14 | +++++ Second parameter*
|
|---|
| 15 | *Second parameter* can be the name of a wiki word to open, if not
|
|---|
| 16 | specified in the first parameter.
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | ++ New form
|
|---|
| 20 |
|
|---|
| 21 | You can specify switches and/or parameters on the command line where
|
|---|
| 22 | the names of the switches either consist of a '-' and a character
|
|---|
| 23 | (short form, e.g. "-h") or begin with two dashes and a name (long
|
|---|
| 24 | form, e.g. "--help").
|
|---|
| 25 |
|
|---|
| 26 | Some switches also take a parameter which must follow the switch on
|
|---|
| 27 | the command line.
|
|---|
| 28 |
|
|---|
| 29 | The following list of switches shows the short form (not present for
|
|---|
| 30 | all options), the long form and (if necessary) the meaning of the
|
|---|
| 31 | parameter in angle brackets:
|
|---|
| 32 |
|
|---|
| 33 |
|
|---|
| 34 | +++ General
|
|---|
| 35 |
|
|---|
| 36 | +++++ -h, --help
|
|---|
| 37 | Shows a message box with a short overview of available switches.
|
|---|
| 38 |
|
|---|
| 39 | +++++ -w, --wiki <wiki path>
|
|---|
| 40 | Set the wiki to open on startup (same as first parameter of old form).
|
|---|
| 41 |
|
|---|
| 42 | +++++ -p, --page <page name>
|
|---|
| 43 | Set the page to open on startup (same as second parameter of old form). You can repeat this parameter multiple times to open multiple tabs.
|
|---|
| 44 |
|
|---|
| 45 | +++++ --rebuild
|
|---|
| 46 | Rebuild the opened wiki.
|
|---|
| 47 |
|
|---|
| 48 | +++++ --no-recent
|
|---|
| 49 | Do not record opened wikis in recently opened wikis list found in menu "Wiki" as submenu "Recent"
|
|---|
| 50 |
|
|---|
| 51 | +++++ --preview
|
|---|
| 52 | If no pages are given, all opened pages from previous session are opened in preview mode. Otherwise all pages mentioned on command line after that option are opened in preview mode.
|
|---|
| 53 |
|
|---|
| 54 | +++++ --editor
|
|---|
| 55 | Same as --preview but opens in text editor mode. You can use both switches in conjunction, e.g.
|
|---|
| 56 |
|
|---|
| 57 | -p Page1 --preview -p Page2 -p Page3 --editor -p Page4
|
|---|
| 58 |
|
|---|
| 59 | opens Page1 in editor mode (editor is the default mode), Page2 and Page3 are opened as preview, Page4 in editor mode again
|
|---|
| 60 |
|
|---|
| 61 | +++++ -x, --exit
|
|---|
| 62 | Exit immediately after command line actions were completed.
|
|---|
| 63 |
|
|---|
| 64 |
|
|---|
| 65 | +++ Exporting
|
|---|
| 66 |
|
|---|
| 67 | The following three must all be specified if you want to export
|
|---|
| 68 | something, the fourth (--export-compfn) is optional:
|
|---|
| 69 |
|
|---|
| 70 | +++++ --export-what <what>
|
|---|
| 71 | Choose if you want to export *page*, *subtree* or *wiki*.
|
|---|
| 72 |
|
|---|
| 73 | +++++ --export-type <type>
|
|---|
| 74 | Tag of the export type. Currently this can be:
|
|---|
| 75 |
|
|---|
| 76 | * html_single: A single WikiPage per HTML file
|
|---|
| 77 | * html_multi: Multiple WikiPages in one HTML file
|
|---|
| 78 | * raw_files: Set of \*.wiki files in UTF-8 format with BOM
|
|---|
| 79 |
|
|---|
| 80 | Attention: In 1.9 the meaning of "html_single" and "html_multi"
|
|---|
| 81 | were reversed!
|
|---|
| 82 |
|
|---|
| 83 | +++++ --export-dest <destination path>
|
|---|
| 84 | Path of destination directory for export.
|
|---|
| 85 |
|
|---|
| 86 |
|
|---|
| 87 | +++++ --export-compfn
|
|---|
| 88 | Use compatible filenames on export.
|
|---|
| 89 |
|
|---|
| 90 | +++++ --export-saved <name of saved export>
|
|---|
| 91 | Instead of the first three you can also use this to run a previously saved export profile
|
|---|
| 92 |
|
|---|
| 93 | +++++ --continuous-export-saved <name of saved export>
|
|---|
| 94 | Use this to start a continuous export when starting WikidPad
|
|---|
| 95 |
|
|---|
| 96 |
|
|---|
| 97 | +++ Special
|
|---|
| 98 |
|
|---|
| 99 | +++++ --deleteconfig
|
|---|
| 100 | If this is the only switch on the command line, the program deletes
|
|---|
| 101 | (*without further request!*) the configuration files which are the
|
|---|
| 102 | main "WikidPad.config" file as well as everything in
|
|---|
| 103 | ".WikidPadGlobals" directory (normally only the global text blocks
|
|---|
| 104 | file).
|
|---|
| 105 |
|
|---|
| 106 | After that the program terminates immediately (otherwise the files
|
|---|
| 107 | would be recreated).
|
|---|
| 108 |
|
|---|
| 109 | This switch is mainly used for the uninstalling of a MsWindowsBinary.
|
|---|
| 110 | The uninstaller *will* ask before running WikidPad with this option.
|
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 | [:page:PageFooter][icon:console] |
|---|
