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/plugins/amazon_s3.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/plugins/amazon_s3.mdwn')
-rw-r--r-- | doc/plugins/amazon_s3.mdwn | 6 |
1 files changed, 3 insertions, 3 deletions
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. |