From 643a97359791ba6b85bb1cf1ee49897f369e0fe4 Mon Sep 17 00:00:00 2001 From: Amitai Schleier Date: Thu, 12 Apr 2018 00:07:58 -0400 Subject: Revert spam commits. --- doc/Pagina.html | 401 --------------------- doc/Pagina/discussion.mdwn | 1 - doc/bugs/discussion.mdwn | 2 +- ...undoes_email_obfuscation_by_Text::Markdown.mdwn | 2 +- ...ki__44___gitosis_and_apache2_in_Debian_Sid.mdwn | 2 +- ...ransition_from_handwritten_html_to_ikiwiki.mdwn | 2 +- doc/ikiwikiusers.mdwn | 1 + doc/index.mdwn | 2 +- doc/plugins.mdwn | 2 +- doc/rcs/git.mdwn | 2 +- doc/setup.mdwn | 2 +- doc/setup/byhand.mdwn | 4 +- doc/usage.mdwn | 401 +++++++++++++++++++++ doc/usage/discussion.mdwn | 1 + 14 files changed, 413 insertions(+), 412 deletions(-) delete mode 100644 doc/Pagina.html delete mode 100644 doc/Pagina/discussion.mdwn create mode 100644 doc/usage.mdwn create mode 100644 doc/usage/discussion.mdwn diff --git a/doc/Pagina.html b/doc/Pagina.html deleted file mode 100644 index 4bfe2312c..000000000 --- a/doc/Pagina.html +++ /dev/null @@ -1,401 +0,0 @@ -# NAME - -ikiwiki - a wiki compiler - -# SYNOPSIS - -ikiwiki [options] source destination - -ikiwiki --setup setupfile [options] - -# DESCRIPTION - -`ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from -`source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to -`destination`. - -Note that most options can be shortened to single letters, boolean -flags such as --verbose can be negated with --no-verbose, and -options such as --verbose can also be spelled like -verbose. - -# MODE OPTIONS - -These options control the mode that ikiwiki operates in. - -* --refresh - - Refresh the wiki, updating any changed pages. This is the default - behavior if no other mode action is specified (but note that --setup is - a mode action, and has different default behavior). - -* --rebuild - - Force a rebuild of all pages. - -* --setup setupfile - - Load options from the given setup file. If no other mode action is specified, - generate wrappers and rebuild the wiki, as if --rebuild --wrappers were used. - If you only want to build any changed pages, you can use --refresh with - --setup. - -* --changesetup setupfile - - Reads the setup file, adds any configuration changes specified by other - options, and writes the new configuration back to the setup file. Also - updates any configured wrappers. In this mode, the wiki is not fully - rebuilt, unless you also add --rebuild. - - Example, to enable some plugins: - - ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendar - -* --dumpsetup setupfile - - Causes ikiwiki to write to the specified setup file, dumping out - its current configuration. - -* --wrappers - - If used with --setup --refresh, this makes it also update any configured - wrappers. - -* --clean - - This makes ikiwiki clean up by removing any files it generated in the - `destination` directory, as well as any configured wrappers, and the - `.ikiwiki` state directory. This is mostly useful if you're running - ikiwiki in a Makefile to build documentation and want a corresponding - `clean` target. - -* --cgi - - Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and - supports editing pages, signing in, and registration. - - To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup - to generate a wrapper. The wrapper will generally need to run suid 6755 to - the user who owns the `source` and `destination` directories. - -* --wrapper [file] - - Generate a wrapper binary that is hardcoded to do action specified by - the other options, using the specified input files and `destination` - directory. The filename to use for the wrapper is optional. - - The wrapper is designed to be safely made suid and be run by untrusted - users, as a [[post-commit]] hook, or as a [[CGI]]. - - Note that the generated wrapper will ignore all command line parameters. - -* --aggregate - - If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll - configured feeds and save new posts to the srcdir. - - Note that to rebuild previously aggregated posts, use the --rebuild option - along with this one. --rebuild will also force feeds to be polled even if - they were polled recently. - -* --render file - - Renders a single file, outputting the resulting html. Does not save state, - so this cannot be used for building whole wikis, but it is useful for - previewing an edited file at the command line. Generally used in conjunction - with --setup to load in a wiki's setup: - - ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn - -* --post-commit - - Run in post-commit mode, the same as if called by a [[post-commit]] hook. - This is probably only useful when using ikiwiki with a web server on one host - and a repository on another, to allow the repository's real post-commit - hook to ssh to the web server host and manually run ikiwiki to update - the web site. - -* --version - - Print ikiwiki's version number. - -# CONFIG OPTIONS - -These options configure the wiki. Note that [[plugins]] can add additional -configuration options of their own. All of these options and more besides can -also be configured using a setup file. - -* --wikiname name - - The name of the wiki, default is "wiki". - -* --templatedir dir - - Specify the directory that [[templates|templates]] are stored in. - Default is `/usr/share/ikiwiki/templates`, or another location as configured at - build time. If the templatedir is changed, missing templates will still - be searched for in the default location as a fallback. Templates can also be - placed in the "templates/" subdirectory of the srcdir. - - Note that if you choose to copy and modify ikiwiki's templates, you will need - to be careful to keep them up to date when upgrading to new versions of - ikiwiki. Old versions of templates do not always work with new ikiwiki - versions. - -* --underlaydir dir - - Specify the directory that is used to underlay the source directory. - Source files will be taken from here unless overridden by a file in the - source directory. Default is `/usr/share/ikiwiki/basewiki` or another - location as configured at build time. - -* --wrappermode mode - - Specify a mode to chmod the wrapper to after creating it. - -* --wrappergroup group - - Specify what unix group the wrapper should be owned by. This can be - useful if the wrapper needs to be owned by a group other than the default. - For example, if a project has a repository with multiple committers with - access controlled by a group, it makes sense for the ikiwiki wrappers - to run setgid to that group. - -* --rcs=svn|git|.., --no-rcs - - Enable or disable use of a [[revision_control_system|rcs]]. - - The `source` directory will be assumed to be a working copy, or clone, or - whatever the revision control system you select uses. - - In [[CGI]] mode, with a revision control system enabled, pages edited via - the web will be committed. - - No revision control is enabled by default. - -* --svnrepo /svn/wiki - - Specify the location of the svn repository for the wiki. - -* --svnpath trunk - - Specify the path inside your svn repository where the wiki is located. - This defaults to `trunk`; change it if your wiki is at some other path - inside the repository. If your wiki is rooted at the top of the repository, - set svnpath to "". - -* --rss, --norss - - If rss is set, ikiwiki will default to generating RSS feeds for pages - that inline a [[blog]]. - -* --allowrss - - If allowrss is set, and rss is not set, ikiwiki will not default to - generating RSS feeds, but setting `rss=yes` in the inline directive can - override this default and generate a feed. - -* --atom, --noatom - - If atom is set, ikiwiki will default to generating Atom feeds for pages - that inline a [[blog]]. - -* --allowatom - - If allowatom is set, and rss is not set, ikiwiki will not default to - generating Atom feeds, but setting `atom=yes` in the inline directive can - override this default and generate a feed. - -* --pingurl URL - - Set this to the URL of an XML-RPC service to ping when an RSS feed is - updated. For example, to ping Technorati, use the URL - http://rpc.technorati.com/rpc/ping - - This parameter can be specified multiple times to specify more than one - URL to ping. - -* --url URL - - Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode. - -* --cgiurl http://example.org/ikiwiki.cgi - - Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when - building the wiki for links to the cgi script to be generated. - -* --historyurl URL - - Specifies the URL to link to for page history browsing. In the URL, - "\[[file]]" is replaced with the file to browse. It's common to use - [[ViewVC]] for this. - -* --adminemail you@example.org - - Specifies the email address that ikiwiki should use for sending email. - -* --diffurl URL - - Specifies the URL to link to for a diff of changes to a page. In the URL, - "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old - revision of the page, and "\[[r2]]" is the new revision. It's common to use - [[ViewVC]] for this. - -* --exclude regexp - - Specifies a rexexp of source files to exclude from processing. - May be specified multiple times to add to exclude list. - -* --include regexp - - Specifies a rexexp of source files, that would normally be excluded, - but that you wish to include in processing. - May be specified multiple times to add to include list. - -* --adminuser name - - Specifies a username of a user (or, if openid is enabled, an openid) - who has the powers of a wiki admin. Currently allows locking of any page, - and [[banning|banned_users]] users, as well as powers granted by - enabled plugins (such as [[moderating comments|plugins/moderatedcomments]] - and [[plugins/websetup]]. May be specified multiple times for multiple - admins. - - For an openid user specify the full URL of the login, including "http://". - -* --plugin name - - Enables the use of the specified [[plugin|plugins]] in the wiki. - Note that plugin names are case sensitive. - -* --disable-plugin name - - Disables use of a plugin. For example "--disable-plugin htmlscrubber" - to do away with HTML sanitization. - -* --libdir directory - - Makes ikiwiki look in the specified directory first, before the regular - locations when loading library files and plugins. For example, if you set - libdir to "/home/you/.ikiwiki/", you can install a foo.pm plugin as - "/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm". - -* --discussion, --no-discussion - - Enables or disables "Discussion" links from being added to the header of - every page. The links are enabled by default. - -* --numbacklinks n - - Controls how many backlinks should be displayed at the bottom of a page. - Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to - disable this feature. - -* --userdir subdir - - Optionally, allows links to users of the wiki to link to pages inside a - subdirectory of the wiki. The default is to link to pages in the toplevel - directory of the wiki. - -* --htmlext html - - Configures the extension used for generated html files. Default is "html". - -* --timeformat format - - Specify how to display the time or date. The format string is passed to the - strftime(3) function. - -* --verbose, --no-verbose - - Be verbose about what is being done. - -* --syslog, --no-syslog - - Log to syslog(3). - -* --usedirs, --no-usedirs - - Toggle creating output files named page/index.html (default) instead of page.html. - -* --prefix-directives, --no-prefix-directives - - Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently - defaults to --prefix-directives. - -* --w3mmode, --no-w3mmode - - Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, - without a web server. - -* --sslcookie - - Only send cookies over an SSL connection. This should prevent them being - intercepted. If you enable this option then you must run at least the - CGI portion of ikiwiki over SSL. - -* --gettime, --no-gettime - - Extract creation and modification times for each new page from the - the revision control's log. This is done automatically when building a - wiki for the first time, so you normally do not need to use this option. - -* --set var=value - - This allows setting an arbitrary configuration variable, the same as if it - were set via a setup file. Since most commonly used options can be - configured using command-line switches, you will rarely need to use this. - -* --set-yaml var=value - - This is like --set, but it allows setting configuration variables that - use complex data structures, by passing in a YAML document. - -# EXAMPLES - -* ikiwiki --setup my.setup - - Completely (re)build the wiki using the specified setup file. - -* ikiwiki --setup my.setup --refresh - - Refresh the wiki, using settings from my.setup, and avoid - rebuilding any pages that have not changed. This is faster. - -* ikiwiki --setup my.setup --refresh --wrappers - - Refresh the wiki, including regenerating all wrapper programs, - but do not rebuild all pages. Useful if you have changed something - in the setup file that does not need a full wiki rebuild to update - all pages, but that you want to immediately take effect. - -* ikiwiki --rebuild srcdir destdir - - Use srcdir as source and build HTML in destdir, without using a - setup file. - -* ikiwiki srcdir destdir - - Use srcdir as source to update changed pages' HTML in destdir, - without using a setup file. - -# ENVIRONMENT - -* CC - - This controls what C compiler is used to build wrappers. Default is 'cc'. - -* CFLAGS - - This can be used to pass options to the C compiler when building wrappers. - -# SEE ALSO - -* [[ikiwiki-mass-rebuild]](8) -* [[ikiwiki-update-wikilist]](1) -* [[ikiwiki-transition]](1) - -# AUTHOR - -Joey Hess - -Warning: Automatically converted into a man page by mdwn2man. Edit with care diff --git a/doc/Pagina/discussion.mdwn b/doc/Pagina/discussion.mdwn deleted file mode 100644 index 189d74eb0..000000000 --- a/doc/Pagina/discussion.mdwn +++ /dev/null @@ -1 +0,0 @@ -Man page does not document "account\_creation\_password". I started to add it, then noticed other configurations are not documented in the manual page either. --[[JeremyReed]] diff --git a/doc/bugs/discussion.mdwn b/doc/bugs/discussion.mdwn index 5a0da04d4..474e07564 100644 --- a/doc/bugs/discussion.mdwn +++ b/doc/bugs/discussion.mdwn @@ -15,4 +15,4 @@ the ikiwiki.cgi CGI wrapper. ..." to the user who owns the `source` and `destination` directories. > (emphasis mine). Anyway, if you have ideas to improve the man page, it's -> over in [[Pagina]] --[[Joey]] +> over in [[usage]] --[[Joey]] diff --git a/doc/bugs/htmlscrubber_undoes_email_obfuscation_by_Text::Markdown.mdwn b/doc/bugs/htmlscrubber_undoes_email_obfuscation_by_Text::Markdown.mdwn index 89df6789a..99cc1964c 100644 --- a/doc/bugs/htmlscrubber_undoes_email_obfuscation_by_Text::Markdown.mdwn +++ b/doc/bugs/htmlscrubber_undoes_email_obfuscation_by_Text::Markdown.mdwn @@ -1,4 +1,4 @@ -From the source of [[Pagina]]: +From the source of [[usage]]: joey@ikiwiki.info diff --git a/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn b/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn index 1b9f0a039..b8e28e0a3 100644 --- a/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn +++ b/doc/forum/multi-user_setup_of_ikiwiki__44___gitosis_and_apache2_in_Debian_Sid.mdwn @@ -36,7 +36,7 @@ I could not come up with a working set of users which are put into different gro > You can set the umask for ikiwiki itself, without changing the system umask, via the usmask setting in the setup file. --[[Joey]] -In the end, I did the following. I created a directory /srv/ikiwiki/ which is owned by gitosis. The [[setup_file|/Pagina]] is also located there (/srv/ikiwiki/project.setup). I put the srcdir there too (srcdir => '/srv/ikiwiki/project/'). So now sudo -u gitosis ikiwiki --project.setup is able to create the post-update hook (git_wrapper => '/srv/gitosis/repositories/project.git/hooks/post-update'). Since this hook is called every time something is checked in over SSH, it is run by gitosis, so I did not set it suid. Or do I have to, because ikiwiki.cgi will be run as www-data? +In the end, I did the following. I created a directory /srv/ikiwiki/ which is owned by gitosis. The [[setup_file|/usage]] is also located there (/srv/ikiwiki/project.setup). I put the srcdir there too (srcdir => '/srv/ikiwiki/project/'). So now sudo -u gitosis ikiwiki --project.setup is able to create the post-update hook (git_wrapper => '/srv/gitosis/repositories/project.git/hooks/post-update'). Since this hook is called every time something is checked in over SSH, it is run by gitosis, so I did not set it suid. Or do I have to, because ikiwiki.cgi will be run as www-data? > Generally, ikiwiki.cgi is run as the user who owns the wiki and repository, in this case, gitosis. The ikwiiki.cgi needs to be able to write to source files in the wiki; it needs to be able to commit changes, > and it needs to be able to generate and write the html files. If you don't want ikiwiki.cgi to run as gitosis, you will need to put gitosis and www-data in a group and give them both write access, with appropriate umask, etc. --[[Joey]] diff --git a/doc/forum/transition_from_handwritten_html_to_ikiwiki.mdwn b/doc/forum/transition_from_handwritten_html_to_ikiwiki.mdwn index 753e18ed2..a8d04a0ad 100644 --- a/doc/forum/transition_from_handwritten_html_to_ikiwiki.mdwn +++ b/doc/forum/transition_from_handwritten_html_to_ikiwiki.mdwn @@ -14,7 +14,7 @@ Thanks, > dest/foo.html, src/bar.mdwn becomes dest/bar.html, etc. > > It sounds like you want `--no-usedirs`, or the corresponding `usedirs => 0,` -> option in your setup file. See [[Pagina]] for more information. -- [[Jon]] +> option in your setup file. See [[usage]] for more information. -- [[Jon]] Thanks, usedirs seems to be just the thing I need. diff --git a/doc/ikiwikiusers.mdwn b/doc/ikiwikiusers.mdwn index 5f177ae7b..e33ed8f2b 100644 --- a/doc/ikiwikiusers.mdwn +++ b/doc/ikiwikiusers.mdwn @@ -194,6 +194,7 @@ Personal sites and blogs * [Salient Dream](http://www.salientdream.com/) - All Things Strange. * [Anton Berezin's blog](http://blog.tobez.org/) * [Waldgarten]( http://waldgarten.greenonion.org/ ) News and documentation of a permaculture inspired neighbourhood-garden located in Hamburg, Germany. +* [Frohdo](https://frohdo.de) - With raw food against back pain and other diseases * [[OscarMorante]]'s [personal site](http://oscar.morante.eu). * [Puckspage]( http://www.puckspage.org/ ) Political and personal blog in German. The name comes from the elf out of midsummer nights dream. * [[LucaCapello]]'s [homepage](http://luca.pca.it) diff --git a/doc/index.mdwn b/doc/index.mdwn index 67745799b..e0e401656 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -15,7 +15,7 @@ site generator with some dynamic features. ## using ikiwiki [[Setup]] has a tutorial for setting up ikiwiki, or you can read the -[[man_page|Pagina]]. There are some [[examples]] of things you can do +[[man_page|usage]]. There are some [[examples]] of things you can do with ikiwiki, and some [[tips]]. Basic documentation for ikiwiki plugins and syntax is provided [[here|ikiwiki]]. The [[forum]] is open for discussions. diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index ff24e1bca..0bea33592 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -7,7 +7,7 @@ There's documentation if you want to [[write]] your own plugins, or you can [[install]] plugins [[contributed|contrib]] by others. To enable a plugin, use the `--plugin` switch described in -[[Pagina]], or the equivalent `add_plugins` line in ikiwiki.setup. +[[usage]], or the equivalent `add_plugins` line in ikiwiki.setup. Enable the [[goodstuff]] plugin to get a nice selection of plugins that will fit most uses of ikiwiki. diff --git a/doc/rcs/git.mdwn b/doc/rcs/git.mdwn index 1839d0829..fa7a037ba 100644 --- a/doc/rcs/git.mdwn +++ b/doc/rcs/git.mdwn @@ -51,7 +51,7 @@ One setup that will work is to put all committers in a group (say, "ikiwiki"), and use permissions to allow that group to commit to the bare git repository. Make both the post-update hook and ikiwiki.cgi be setgid to the group, as well as suid to the user who admins the wiki. The -`wrappergroup` [[setup_file_option|Pagina]] can be used to make the wrappers +`wrappergroup` [[setup_file_option|usage]] can be used to make the wrappers be setgid to the right group. Then the srcdir, including its git repository, should only be writable by the wiki's admin, and *not* by the group. Take care that ikiwiki uses a umask that does not cause files in diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 0d532f337..9fc37c0b1 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -113,7 +113,7 @@ Alternatively, you can ask ikiwiki to change settings in the file for you: % ikiwiki --changesetup foo.setup --plugin goodstuff -See [[Pagina]] for more options. +See [[usage]] for more options. ## Customizing file locations diff --git a/doc/setup/byhand.mdwn b/doc/setup/byhand.mdwn index 2b0defe64..6d0f37cd9 100644 --- a/doc/setup/byhand.mdwn +++ b/doc/setup/byhand.mdwn @@ -64,7 +64,7 @@ can copy in files from the [[examples]]. The examples are located in You can experiment with other ikiwiki parameters such as `--wikiname` and `--rebuild` too. Get comfortable with its command line (see -[[Pagina]]). +[[usage]]). ## Add a setup file. @@ -83,7 +83,7 @@ the rest of the files. A good place to put it is in a ~/.ikiwiki/ subdirectory. Most of the options, like `wikiname` in the setup file are the same as -ikiwiki's command line options (documented in [[Pagina]]). `srcdir` and +ikiwiki's command line options (documented in [[usage]]). `srcdir` and `destdir` are the two directories you specify when running ikiwiki by hand. Make sure that these are pointing to the right directories, and read through and configure the rest of the file to your liking. diff --git a/doc/usage.mdwn b/doc/usage.mdwn new file mode 100644 index 000000000..4bfe2312c --- /dev/null +++ b/doc/usage.mdwn @@ -0,0 +1,401 @@ +# NAME + +ikiwiki - a wiki compiler + +# SYNOPSIS + +ikiwiki [options] source destination + +ikiwiki --setup setupfile [options] + +# DESCRIPTION + +`ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from +`source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to +`destination`. + +Note that most options can be shortened to single letters, boolean +flags such as --verbose can be negated with --no-verbose, and +options such as --verbose can also be spelled like -verbose. + +# MODE OPTIONS + +These options control the mode that ikiwiki operates in. + +* --refresh + + Refresh the wiki, updating any changed pages. This is the default + behavior if no other mode action is specified (but note that --setup is + a mode action, and has different default behavior). + +* --rebuild + + Force a rebuild of all pages. + +* --setup setupfile + + Load options from the given setup file. If no other mode action is specified, + generate wrappers and rebuild the wiki, as if --rebuild --wrappers were used. + If you only want to build any changed pages, you can use --refresh with + --setup. + +* --changesetup setupfile + + Reads the setup file, adds any configuration changes specified by other + options, and writes the new configuration back to the setup file. Also + updates any configured wrappers. In this mode, the wiki is not fully + rebuilt, unless you also add --rebuild. + + Example, to enable some plugins: + + ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendar + +* --dumpsetup setupfile + + Causes ikiwiki to write to the specified setup file, dumping out + its current configuration. + +* --wrappers + + If used with --setup --refresh, this makes it also update any configured + wrappers. + +* --clean + + This makes ikiwiki clean up by removing any files it generated in the + `destination` directory, as well as any configured wrappers, and the + `.ikiwiki` state directory. This is mostly useful if you're running + ikiwiki in a Makefile to build documentation and want a corresponding + `clean` target. + +* --cgi + + Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and + supports editing pages, signing in, and registration. + + To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup + to generate a wrapper. The wrapper will generally need to run suid 6755 to + the user who owns the `source` and `destination` directories. + +* --wrapper [file] + + Generate a wrapper binary that is hardcoded to do action specified by + the other options, using the specified input files and `destination` + directory. The filename to use for the wrapper is optional. + + The wrapper is designed to be safely made suid and be run by untrusted + users, as a [[post-commit]] hook, or as a [[CGI]]. + + Note that the generated wrapper will ignore all command line parameters. + +* --aggregate + + If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll + configured feeds and save new posts to the srcdir. + + Note that to rebuild previously aggregated posts, use the --rebuild option + along with this one. --rebuild will also force feeds to be polled even if + they were polled recently. + +* --render file + + Renders a single file, outputting the resulting html. Does not save state, + so this cannot be used for building whole wikis, but it is useful for + previewing an edited file at the command line. Generally used in conjunction + with --setup to load in a wiki's setup: + + ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn + +* --post-commit + + Run in post-commit mode, the same as if called by a [[post-commit]] hook. + This is probably only useful when using ikiwiki with a web server on one host + and a repository on another, to allow the repository's real post-commit + hook to ssh to the web server host and manually run ikiwiki to update + the web site. + +* --version + + Print ikiwiki's version number. + +# CONFIG OPTIONS + +These options configure the wiki. Note that [[plugins]] can add additional +configuration options of their own. All of these options and more besides can +also be configured using a setup file. + +* --wikiname name + + The name of the wiki, default is "wiki". + +* --templatedir dir + + Specify the directory that [[templates|templates]] are stored in. + Default is `/usr/share/ikiwiki/templates`, or another location as configured at + build time. If the templatedir is changed, missing templates will still + be searched for in the default location as a fallback. Templates can also be + placed in the "templates/" subdirectory of the srcdir. + + Note that if you choose to copy and modify ikiwiki's templates, you will need + to be careful to keep them up to date when upgrading to new versions of + ikiwiki. Old versions of templates do not always work with new ikiwiki + versions. + +* --underlaydir dir + + Specify the directory that is used to underlay the source directory. + Source files will be taken from here unless overridden by a file in the + source directory. Default is `/usr/share/ikiwiki/basewiki` or another + location as configured at build time. + +* --wrappermode mode + + Specify a mode to chmod the wrapper to after creating it. + +* --wrappergroup group + + Specify what unix group the wrapper should be owned by. This can be + useful if the wrapper needs to be owned by a group other than the default. + For example, if a project has a repository with multiple committers with + access controlled by a group, it makes sense for the ikiwiki wrappers + to run setgid to that group. + +* --rcs=svn|git|.., --no-rcs + + Enable or disable use of a [[revision_control_system|rcs]]. + + The `source` directory will be assumed to be a working copy, or clone, or + whatever the revision control system you select uses. + + In [[CGI]] mode, with a revision control system enabled, pages edited via + the web will be committed. + + No revision control is enabled by default. + +* --svnrepo /svn/wiki + + Specify the location of the svn repository for the wiki. + +* --svnpath trunk + + Specify the path inside your svn repository where the wiki is located. + This defaults to `trunk`; change it if your wiki is at some other path + inside the repository. If your wiki is rooted at the top of the repository, + set svnpath to "". + +* --rss, --norss + + If rss is set, ikiwiki will default to generating RSS feeds for pages + that inline a [[blog]]. + +* --allowrss + + If allowrss is set, and rss is not set, ikiwiki will not default to + generating RSS feeds, but setting `rss=yes` in the inline directive can + override this default and generate a feed. + +* --atom, --noatom + + If atom is set, ikiwiki will default to generating Atom feeds for pages + that inline a [[blog]]. + +* --allowatom + + If allowatom is set, and rss is not set, ikiwiki will not default to + generating Atom feeds, but setting `atom=yes` in the inline directive can + override this default and generate a feed. + +* --pingurl URL + + Set this to the URL of an XML-RPC service to ping when an RSS feed is + updated. For example, to ping Technorati, use the URL + http://rpc.technorati.com/rpc/ping + + This parameter can be specified multiple times to specify more than one + URL to ping. + +* --url URL + + Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode. + +* --cgiurl http://example.org/ikiwiki.cgi + + Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when + building the wiki for links to the cgi script to be generated. + +* --historyurl URL + + Specifies the URL to link to for page history browsing. In the URL, + "\[[file]]" is replaced with the file to browse. It's common to use + [[ViewVC]] for this. + +* --adminemail you@example.org + + Specifies the email address that ikiwiki should use for sending email. + +* --diffurl URL + + Specifies the URL to link to for a diff of changes to a page. In the URL, + "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old + revision of the page, and "\[[r2]]" is the new revision. It's common to use + [[ViewVC]] for this. + +* --exclude regexp + + Specifies a rexexp of source files to exclude from processing. + May be specified multiple times to add to exclude list. + +* --include regexp + + Specifies a rexexp of source files, that would normally be excluded, + but that you wish to include in processing. + May be specified multiple times to add to include list. + +* --adminuser name + + Specifies a username of a user (or, if openid is enabled, an openid) + who has the powers of a wiki admin. Currently allows locking of any page, + and [[banning|banned_users]] users, as well as powers granted by + enabled plugins (such as [[moderating comments|plugins/moderatedcomments]] + and [[plugins/websetup]]. May be specified multiple times for multiple + admins. + + For an openid user specify the full URL of the login, including "http://". + +* --plugin name + + Enables the use of the specified [[plugin|plugins]] in the wiki. + Note that plugin names are case sensitive. + +* --disable-plugin name + + Disables use of a plugin. For example "--disable-plugin htmlscrubber" + to do away with HTML sanitization. + +* --libdir directory + + Makes ikiwiki look in the specified directory first, before the regular + locations when loading library files and plugins. For example, if you set + libdir to "/home/you/.ikiwiki/", you can install a foo.pm plugin as + "/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm". + +* --discussion, --no-discussion + + Enables or disables "Discussion" links from being added to the header of + every page. The links are enabled by default. + +* --numbacklinks n + + Controls how many backlinks should be displayed at the bottom of a page. + Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to + disable this feature. + +* --userdir subdir + + Optionally, allows links to users of the wiki to link to pages inside a + subdirectory of the wiki. The default is to link to pages in the toplevel + directory of the wiki. + +* --htmlext html + + Configures the extension used for generated html files. Default is "html". + +* --timeformat format + + Specify how to display the time or date. The format string is passed to the + strftime(3) function. + +* --verbose, --no-verbose + + Be verbose about what is being done. + +* --syslog, --no-syslog + + Log to syslog(3). + +* --usedirs, --no-usedirs + + Toggle creating output files named page/index.html (default) instead of page.html. + +* --prefix-directives, --no-prefix-directives + + Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently + defaults to --prefix-directives. + +* --w3mmode, --no-w3mmode + + Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, + without a web server. + +* --sslcookie + + Only send cookies over an SSL connection. This should prevent them being + intercepted. If you enable this option then you must run at least the + CGI portion of ikiwiki over SSL. + +* --gettime, --no-gettime + + Extract creation and modification times for each new page from the + the revision control's log. This is done automatically when building a + wiki for the first time, so you normally do not need to use this option. + +* --set var=value + + This allows setting an arbitrary configuration variable, the same as if it + were set via a setup file. Since most commonly used options can be + configured using command-line switches, you will rarely need to use this. + +* --set-yaml var=value + + This is like --set, but it allows setting configuration variables that + use complex data structures, by passing in a YAML document. + +# EXAMPLES + +* ikiwiki --setup my.setup + + Completely (re)build the wiki using the specified setup file. + +* ikiwiki --setup my.setup --refresh + + Refresh the wiki, using settings from my.setup, and avoid + rebuilding any pages that have not changed. This is faster. + +* ikiwiki --setup my.setup --refresh --wrappers + + Refresh the wiki, including regenerating all wrapper programs, + but do not rebuild all pages. Useful if you have changed something + in the setup file that does not need a full wiki rebuild to update + all pages, but that you want to immediately take effect. + +* ikiwiki --rebuild srcdir destdir + + Use srcdir as source and build HTML in destdir, without using a + setup file. + +* ikiwiki srcdir destdir + + Use srcdir as source to update changed pages' HTML in destdir, + without using a setup file. + +# ENVIRONMENT + +* CC + + This controls what C compiler is used to build wrappers. Default is 'cc'. + +* CFLAGS + + This can be used to pass options to the C compiler when building wrappers. + +# SEE ALSO + +* [[ikiwiki-mass-rebuild]](8) +* [[ikiwiki-update-wikilist]](1) +* [[ikiwiki-transition]](1) + +# AUTHOR + +Joey Hess + +Warning: Automatically converted into a man page by mdwn2man. Edit with care diff --git a/doc/usage/discussion.mdwn b/doc/usage/discussion.mdwn new file mode 100644 index 000000000..189d74eb0 --- /dev/null +++ b/doc/usage/discussion.mdwn @@ -0,0 +1 @@ +Man page does not document "account\_creation\_password". I started to add it, then noticed other configurations are not documented in the manual page either. --[[JeremyReed]] -- cgit v1.2.3