Go to file
Simon McVittie a1fda0b516 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.
2015-03-01 16:15:01 +00:00
Bundle add XML::Writer suggestion for osm plugin 2012-03-03 12:28:24 -04:00
IkiWiki Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
cpan enhancesments for shared hosting 2008-05-05 14:51:26 -04:00
debian Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
doc Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
icons Replace Verisign logo with one done in Inkscape 2014-02-14 12:27:18 +00:00
plugins plugins/proxy.py: be compatible with Python 3 2014-09-04 11:42:05 +01:00
po Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
t Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
templates page.tmpl: tell mobile browsers we have a responsive layout, unless told not to 2014-12-01 21:29:46 +00:00
themes More page layout adjustments for mobile browsers and small windows 2014-12-01 21:29:46 +00:00
underlays rename so linitian can find the unminified versions 2014-08-15 13:11:32 -04:00
.gitattributes auto changelog merging 2010-06-25 13:43:02 -04:00
.gitignore add ikiwiki-comment program 2014-10-20 12:08:07 -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 If neither timezone nor TZ is set, set both to :/etc/localtime if we're on a GNU system and that file exists, or GMT otherwise 2015-03-01 15:01:05 +00:00
Makefile.PL Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
NEWS * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
README parameterize FIND and SED 2010-09-27 16:10:13 -04:00
auto-blog.setup Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
auto.setup Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
docwiki.setup disable openid when building doc dir 2010-05-15 23:24:57 -04:00
gitremotes gitremotes: don't fetch the new remote until we've turned off tags 2010-05-09 16:44:47 +01:00
ikiwiki-calendar.in Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
ikiwiki-comment.in Optionally accept and emit comments' url/email/ip. 2014-12-28 10:02:26 -05:00
ikiwiki-makerepo remove /recentchanges from .gitignore 2011-12-24 19:43:16 -04:00
ikiwiki-mass-rebuild Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
ikiwiki-transition.in Add preprocessed 'use lib' line to ikiwiki-transition and ikiwiki-calendar if necessary for unusual install. 2010-03-26 13:11:02 -04:00
ikiwiki-update-wikilist update ikiwiki-update-wikilist docs to suggest putting it in /etc/sudoers 2012-08-09 11:48:30 -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 Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +00:00
ikiwiki.spec release 2015-01-07 09:14:47 +00:00
mdwn2man sync mdwn2man changes from git-annex 2010-12-10 17:36:39 -04:00
pm_filter remove -T from ikiwiki.in, add back if NOTAINT=0 2009-05-22 13:46:07 -04:00
wikilist Standardize on --long-option instead of -long-option 2015-03-01 16:15:01 +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.PL:

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

  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)

  MAKE, FIND, and SED can be used to specify where you have the GNU
  versions of those tools installed, if the normal make, find, and sed
  are not GNU.

  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.