ikiwiki

Go to file

JoshTriplett 8cde7554bd Expand acronym.		2008-09-04 18:32:56 -04:00
Bundle	…
IkiWiki	use yesno	2008-09-02 18:20:17 -04:00
cpan	…
debian	For fine control over what characters are allowed, unescaped in source filenames, the wiki_file_chars setting is added. For example, set to "-[:alnum:]+/._" to disable colons from being used in source files (which can cause trouble om Windows).	2008-09-04 14:13:10 -04:00
doc	Expand acronym.	2008-09-04 18:32:56 -04:00
plugins	add getsetup hook	2008-08-06 01:04:45 -04:00
po	For fine control over what characters are allowed, unescaped in source filenames, the wiki_file_chars setting is added. For example, set to "-[:alnum:]+/._" to disable colons from being used in source files (which can cause trouble om Windows).	2008-09-04 14:13:10 -04:00
t	…
templates	…
underlays	rename preprocessordirective to directive	2008-08-25 14:19:39 -04:00
.gitignore	…
.perlcriticrc	fix a common case typo	2008-08-12 15:48:44 -04:00
CHANGELOG	…
IkiWiki.pm	For fine control over what characters are allowed, unescaped in source filenames, the wiki_file_chars setting is added. For example, set to "-[:alnum:]+/._" to disable colons from being used in source files (which can cause trouble om Windows).	2008-09-04 14:13:10 -04:00
Makefile.PL	Ignore failure to install files into /etc, in case install is running as non-root.	2008-08-29 15:53:46 -04:00
NEWS	…
README	…
auto.setup	put monotone dir name munging code in auto.setup	2008-08-22 21:19:53 -04:00
docwiki.setup	…
ikiwiki-makerepo	put monotone dir name munging code in auto.setup	2008-08-22 21:19:53 -04:00
ikiwiki-mass-rebuild	…
ikiwiki-transition	…
ikiwiki-update-wikilist	…
ikiwiki-w3m.cgi	…
ikiwiki.in	…
mdwn2man	…
pm_filter	…
wikilist	…

README

Use ./Makefile.PL to generate a Makefile, "make" will build the
documentation wiki and a man page, and "make install" will install ikiwiki.

A few special variables you can set while using the Makefile:

PROFILE=1 turns on profiling for the build of the doc wiki. Uses Devel::Profile

NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
unless your perl is less buggy than mine -- see
http://bugs.debian.org/411786)

There are also other variables supported by MakeMaker, including PREFIX,
INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).

In particular, INSTALL_BASE is very useful if you want to install ikiwiki
to some other location, as it configures it to see the perl libraries
there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
install ikiwiki and its dependencies in a home directory.

All other documentation is in the ikiwiki documentation wiki, which is also
available online at <http://ikiwiki.info/>