Go to file
Joey Hess 9d5075ab52 first pass through comments documentation
Moved documentation out of contrib.

Mostly tweaked some wording. Moved documentation of various bits to other
pages (pagespec, etc), and linked to those.

Documented the new templates in wikitemplates.

Small quantities of documentation were removed. Particularly the list of
template variables, which I think is fairly obvious when editing the
template.
2008-12-12 14:52:05 -05:00
Bundle typo 2008-06-12 14:54:28 -04:00
IkiWiki htmlbalance: don't compact whitespace, and set misc other options 2008-12-12 14:23:12 -05:00
cpan enhancesments for shared hosting 2008-05-05 14:51:26 -04:00
debian update changelog 2008-12-12 14:29:42 -05:00
doc first pass through comments documentation 2008-12-12 14:52:05 -05:00
plugins function injection overhaul 2008-10-21 17:57:19 -04:00
po inline: Support feedfile option to change the filename of the feed generated. 2008-12-11 15:01:26 -05:00
t use HTML::Entities 2008-11-17 14:27:11 -05:00
templates comments_display.tmpl: use less nice formatting to avoid whitespace in output 2008-12-11 21:14:05 +00:00
underlays use relativedate as the css class for dates that should display relative 2008-10-20 19:22:22 -04:00
.gitignore update ignore 2008-07-26 23:04:54 -04:00
.perlcriticrc fix a common case typo 2008-08-12 15:48:44 -04:00
CHANGELOG * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
IkiWiki.pm inline: Support feedfile option to change the filename of the feed generated. 2008-12-11 15:01:26 -05:00
Makefile.PL add W3M_CGI_BIN setting 1997-08-14 08:26:03 -04:00
NEWS * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
README reformat 2008-09-09 20:24:59 -04:00
auto.setup put monotone dir name munging code in auto.setup 2008-08-22 21:19:53 -04:00
docwiki.setup oops 2008-11-06 20:49:52 -05:00
gitremotes markdown fixes 2008-12-11 13:31:25 -05:00
ikiwiki-makerepo put monotone dir name munging code in auto.setup 2008-08-22 21:19:53 -04:00
ikiwiki-mass-rebuild fix two build bugs 2008-06-13 13:05:44 -04:00
ikiwiki-transition add a guard against multiple cgi or rcs wrappers 2008-08-05 21:02:18 -04:00
ikiwiki-update-wikilist add new wiki to wikilist 2008-07-27 16:01:29 -04:00
ikiwiki-w3m.cgi * Support a w3mmode, which lets w3m run ikiwiki using its local CGI 2006-07-07 21:00:48 +00:00
ikiwiki.in Correct --dumpsetup to include the srcdir in the setup file. 1997-08-14 08:31:42 -04:00
mdwn2man improved period escape 2008-05-30 18:01:16 -04:00
pm_filter If PERL5LIB is set to the libdir when building ikiwiki, calculate and hardcode a proper 'use lib' statement anyway. This fixes a gotcha, since PERL5LIB won't work once ikiwiki is running via a wrapper or as a cgi. 2008-05-14 02:42:01 -04:00
wikilist Fix typo. 2007-04-09 23:54:32 +00:00

README

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

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


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.