aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2015-03-01 16:14:32 +0000
committerSimon McVittie <smcv@debian.org>2015-03-01 16:15:01 +0000
commita1fda0b516cc4e85b7304838949df8fbe0044cf3 (patch)
treecc1a5cade5f89ad2386cd39e8f1e319875c61b8f /doc
parent0700b26b58bac8670b21afb502540c61deac3065 (diff)
downloadikiwiki-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')
-rw-r--r--doc/examples/blog.mdwn2
-rw-r--r--doc/ikiwiki-calendar.mdwn2
-rw-r--r--doc/plugins/amazon_s3.mdwn6
-rw-r--r--doc/plugins/theme.mdwn3
-rw-r--r--doc/rcs/git.mdwn6
-rw-r--r--doc/tips/ikiwiki_on_mac_os_x.mdwn2
-rw-r--r--doc/tips/laptop_wiki_with_git.mdwn4
-rw-r--r--doc/tips/nearlyfreespeech.mdwn4
-rw-r--r--doc/tips/optimising_ikiwiki.mdwn8
-rw-r--r--doc/tips/upgrade_to_3.0.mdwn4
10 files changed, 21 insertions, 20 deletions
diff --git a/doc/examples/blog.mdwn b/doc/examples/blog.mdwn
index 5f8f6c3ce..afef42c30 100644
--- a/doc/examples/blog.mdwn
+++ b/doc/examples/blog.mdwn
@@ -3,7 +3,7 @@ your wiki to quickly get started blogging with ikiwiki.
Or, run this command to set up a blog with ikiwiki.
- % ikiwiki -setup /etc/ikiwiki/auto-blog.setup
+ % ikiwiki --setup /etc/ikiwiki/auto-blog.setup
Some additional configuration you might want to do, if not using
`auto-blog.setup`:
diff --git a/doc/ikiwiki-calendar.mdwn b/doc/ikiwiki-calendar.mdwn
index fd3244694..43db4847d 100644
--- a/doc/ikiwiki-calendar.mdwn
+++ b/doc/ikiwiki-calendar.mdwn
@@ -50,7 +50,7 @@ the pages, `calendarmonth.tmpl` and `calendaryear.tmpl`.
Most of the goals of this command can be replaced by setting up
`calendar_autocreate` setup option (of plugin [[plugins/calendar]]), and
-running `ikiwiki -setup you.setup`. The only thing that `ikiwiki-calendar` can
+running `ikiwiki --setup you.setup`. The only thing that `ikiwiki-calendar` can
do and that `ikiwiki` cannot is forcing page generation (using `-f` switch).
# AUTHOR
diff --git a/doc/plugins/amazon_s3.mdwn b/doc/plugins/amazon_s3.mdwn
index 7fe60cb8d..52c05f9ae 100644
--- a/doc/plugins/amazon_s3.mdwn
+++ b/doc/plugins/amazon_s3.mdwn
@@ -48,11 +48,11 @@ The `hardlink` config file setting is not compatible with this plugin.
## data transfer notes
-If you run 'ikiwiki -setup my.setup' to force a rebuild of your wiki, the
+If you run 'ikiwiki --setup my.setup' to force a rebuild of your wiki, the
entire thing will be re-uploaded to Amazon S3. This will take time, and
cost you money, so it should be avoided as much as possible.
-If you run 'ikiwiki -setup my.setup -refresh', ikiwiki will only upload the
+If you run 'ikiwiki --setup my.setup --refresh', ikiwiki will only upload the
modified pages that it refreshes. Faster and cheaper. Still, if you have
very large pages (for example, a page that inlines hundreds of other pages
.. or is just very large), the complete page contents will be re-uploaded
@@ -64,5 +64,5 @@ it will be re-uploaded, rather than copied.
## deleting a bucket
-You can use "ikiwiki -setup my.setup --delete-bucket" to delete anything
+You can use "ikiwiki --setup my.setup --delete-bucket" to delete anything
that's in the configured bucket, and remove the bucket.
diff --git a/doc/plugins/theme.mdwn b/doc/plugins/theme.mdwn
index 5261df111..bcc36aa81 100644
--- a/doc/plugins/theme.mdwn
+++ b/doc/plugins/theme.mdwn
@@ -8,7 +8,8 @@ inside `/usr/share/ikiwiki/themes/`. See [[themes]] for an overview
of the themes included in ikiwiki and the [[theme market]] for third party themes.
You can set the theme via the **theme** option in your config file (after
-enabling the plugin). Refresh the wiki (with `ikiwiki -setup <file>`, `--setup` won't work, they are not interchangable) after changing it to see the changes.
+enabling the plugin). Refresh the wiki (with `ikiwiki --setup <file>`)
+after changing it to see the changes.
Hints for theme builders
------------------------
diff --git a/doc/rcs/git.mdwn b/doc/rcs/git.mdwn
index c82adbd04..fa7a037ba 100644
--- a/doc/rcs/git.mdwn
+++ b/doc/rcs/git.mdwn
@@ -108,13 +108,13 @@ is the normal behaviour of ikiwiki, set the configuration of the local wiki:
git_wrapper => "/working/dir/.git/hooks/post-commit",
Then just committing should refresh the private ikiwiki on the local
-host. Now just run `ikiwiki -setup localwiki.setup -gettime` and
-you should be good to go. (You only need the slow `-gettime` option
+host. Now just run `ikiwiki --setup localwiki.setup --gettime` and
+you should be good to go. (You only need the slow `--gettime` option
the first time you run setup.) Use standard git commands to handle
pulling from and pushing to the server. **Note**: After
pulling changes from the bare root repository, you will need to
manually update the local wiki, with a command such as `ikiwiki
--setup localwiki.setup -refresh`. You could use git's `post-merge` hook
+--setup localwiki.setup --refresh`. You could use git's `post-merge` hook
to automate that command.
## Using ikiwiki with Gerrit
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