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 | |
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')
-rw-r--r-- | doc/tips/ikiwiki_on_mac_os_x.mdwn | 2 | ||||
-rw-r--r-- | doc/tips/laptop_wiki_with_git.mdwn | 4 | ||||
-rw-r--r-- | doc/tips/nearlyfreespeech.mdwn | 4 | ||||
-rw-r--r-- | doc/tips/optimising_ikiwiki.mdwn | 8 | ||||
-rw-r--r-- | doc/tips/upgrade_to_3.0.mdwn | 4 |
5 files changed, 11 insertions, 11 deletions
diff --git a/doc/tips/ikiwiki_on_mac_os_x.mdwn b/doc/tips/ikiwiki_on_mac_os_x.mdwn index 86b2ac044..9e4aea139 100644 --- a/doc/tips/ikiwiki_on_mac_os_x.mdwn +++ b/doc/tips/ikiwiki_on_mac_os_x.mdwn @@ -185,7 +185,7 @@ it installed without issue so I'm baffled why it didn't install from command lin _ This setup file causes ikiwiki to create a wiki, check it into revision _ control, generate a setup file for the new wiki, and set everything up. - _ Just run: ikiwiki -setup /etc/ikiwiki/auto.setup + _ Just run: ikiwiki --setup /etc/ikiwiki/auto.setup _By default, it asks a few questions, and confines itself to the user's home _directory. You can edit it to change what it asks questions about, or to 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. diff --git a/doc/tips/nearlyfreespeech.mdwn b/doc/tips/nearlyfreespeech.mdwn index a3d1ec678..2e8bdb984 100644 --- a/doc/tips/nearlyfreespeech.mdwn +++ b/doc/tips/nearlyfreespeech.mdwn @@ -78,7 +78,7 @@ Here is an example of how I set up a wiki: mkdir ~/wiki cd ~/wiki cp -r ~/ikiwiki/doc/examples/blog/* . - ikiwiki -dumpsetup ikiwiki.setup + ikiwiki --dumpsetup ikiwiki.setup nano ikiwiki.setup # Set destdir to /home/htdocs # Set srcdir to /home/private/wiki @@ -89,7 +89,7 @@ Here is an example of how I set up a wiki: # Set the git_wrapper path to /home/private/wiki.git/hooks/post-update # Configure the rest to your liking and save the file. ikiwiki-makerepo git . ../wiki.git - ikiwiki -setup ikiwiki.setup + ikiwiki --setup ikiwiki.setup ## Clean up diff --git a/doc/tips/optimising_ikiwiki.mdwn b/doc/tips/optimising_ikiwiki.mdwn index cf412d266..6e8b60617 100644 --- a/doc/tips/optimising_ikiwiki.mdwn +++ b/doc/tips/optimising_ikiwiki.mdwn @@ -17,19 +17,19 @@ it's slow, and get the problem fixed!) Are you building your wiki by running a command like this? - ikiwiki -setup my.setup + ikiwiki --setup my.setup If so, you're always telling ikiwiki to rebuild the entire site, from scratch. But, ikiwiki is smart, it can incrementally update a site, building only things affected by the changes you make. You just have to let it do so: - ikiwiki -setup my.setup -refresh + ikiwiki --setup my.setup --refresh Ikiwiki automatically uses an incremental refresh like this when handing a web edit, or when run from a [[rcs]] post-commit hook. (If you've configured the hook in the usual way.) Most people who have run into this -problem got in the habit of running `ikiwiki -setup my.setup` by hand +problem got in the habit of running `ikiwiki --setup my.setup` by hand when their wiki was small, and found it got slower as they added pages. ## use the latest version @@ -174,7 +174,7 @@ Finally, let's think about how huge number of pages can affect ikiwiki. command. Obviously, more files will make it take longer. You can avoid this scanning overhead, if you're using git, by setting - `only_committed_changes`. This makes ikiwiki -refresh query git for + `only_committed_changes`. This makes ikiwiki --refresh query git for changed files since the last time, which tends to be a lot faster. However, it only works if all files in your wiki are committed to git (or stored in the [[/plugins/transient]] underlay). diff --git a/doc/tips/upgrade_to_3.0.mdwn b/doc/tips/upgrade_to_3.0.mdwn index 05b6d6fbd..4b3a18123 100644 --- a/doc/tips/upgrade_to_3.0.mdwn +++ b/doc/tips/upgrade_to_3.0.mdwn @@ -21,7 +21,7 @@ setup file, and will no longer appear on the admin preferences page once your wiki is upgraded to 3.0. You can move these preferences into the setup file by running -`ikiwiki-transition moveprefs your.setup; ikiwiki -setup your.setup -refresh -wrappers` +`ikiwiki-transition moveprefs your.setup; ikiwiki --setup your.setup --refresh --wrappers` (Make sure you have converted the setup file to the new format first.) @@ -80,7 +80,7 @@ Otherwise, follow this procedure to upgrade a wiki using the aggregate plugin: 2. Use [[ikiwiki-transition]] to rename all existing aggregated `.html` files in the srcdir. The command to run is `ikiwiki-transition aggregateinternal your.setup`, -3. Refresh the wiki. (`ikiwiki -setup your.setup -refresh`) +3. Refresh the wiki. (`ikiwiki --setup your.setup --refresh`) ## embed / googlecalendar |