diff options
author | Simon McVittie <smcv@debian.org> | 2015-03-01 16:14:32 +0000 |
---|---|---|
committer | Simon McVittie <smcv@debian.org> | 2015-03-01 16:15:01 +0000 |
commit | a1fda0b516cc4e85b7304838949df8fbe0044cf3 (patch) | |
tree | cc1a5cade5f89ad2386cd39e8f1e319875c61b8f /doc/tips/laptop_wiki_with_git.mdwn | |
parent | 0700b26b58bac8670b21afb502540c61deac3065 (diff) | |
download | ikiwiki-a1fda0b516cc4e85b7304838949df8fbe0044cf3.tar ikiwiki-a1fda0b516cc4e85b7304838949df8fbe0044cf3.tar.gz |
Standardize on --long-option instead of -long-option
[[forum/refresh_and_setup]] indicates some confusion between --setup
and -setup. Both work, but it's clearer if we stick to one in
documentation and code.
A 2012 commit to [[plugins/theme]] claims that "-setup" is required
and "--setup" won't work, but I cannot find any evidence in ikiwiki's
source code that this has ever been the case.
Diffstat (limited to 'doc/tips/laptop_wiki_with_git.mdwn')
-rw-r--r-- | doc/tips/laptop_wiki_with_git.mdwn | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/tips/laptop_wiki_with_git.mdwn b/doc/tips/laptop_wiki_with_git.mdwn index 4011763fc..3a79e271c 100644 --- a/doc/tips/laptop_wiki_with_git.mdwn +++ b/doc/tips/laptop_wiki_with_git.mdwn @@ -41,7 +41,7 @@ is standard, but a few special settings are needed: and configure it so that each page links to the corresponding page on the server. -Now just run `ikiwiki -setup wiki.setup -getctime` and you should be +Now just run `ikiwiki --setup wiki.setup --getctime` and you should be good to go. (You only need the slow `-getctime` option the first time you run setup.) If you have taken your `wiki.setup` file from an existing wiki, you may need to change certain parameters to adapt to the paths @@ -71,7 +71,7 @@ You can also direct people to the main server for web edition there. Use standard git commands to handle pulling from and pushing to the server. Note that if changes are pulled from the server, you will need to manually -update the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`. +update the wiki, with a command such as `ikiwiki --setup wiki.setup --refresh`. If you'd like it to automatically update when changes are merged in, you can simply make a symlink `post-merge` hook pointing at the `post-update` hook ikiwiki created. |