ikiwiki-クラウドのオンライン

プログラム：

NAME

ikiwiki-wikiコンパイラ

SYNOPSIS

ikiwiki [オプション]ソース宛先

ikiwiki --setup setupfile [オプション]

DESCRIPTION

ikiwikiはwikiコンパイラです。 ウィキの静的HTMLページをソースから構築します。
ikiwiki / Markdown言語（または他の言語）、そしてそれを宛先に書き出します。

ほとんどのオプションは、単一文字、-verboseなどのブールフラグに短縮できることに注意してください
--no-verboseで否定でき、-verboseなどのオプションも次のように綴ることができます。
-詳細。

モード OPTIONS

これらのオプションは、ikiwikiが動作するモードを制御します。

-リフレッシュ
変更されたページを更新して、Wikiを更新します。 いいえの場合、これがデフォルトの動作です
他のモードアクションが指定されています（ただし、-setupはモードアクションであり、
異なるデフォルトの動作）。

-再構築
すべてのページを強制的に再構築します。

--setupsetupfile
指定されたセットアップファイルからオプションをロードします。 他のモードアクションが指定されていない場合、
--rebuild --wrappersが使用されたかのように、ラッパーを生成してWikiを再構築します。 もしも
変更されたページのみをビルドする場合は、-refreshと--setupを使用できます。

--changesetup セットアップファイル
セットアップファイルを読み取り、他のオプションで指定された構成変更を追加します。
新しい構成をセットアップファイルに書き戻します。 また、
構成されたラッパー。 このモードでは、ウィキは完全に再構築されません。
--rebuildを追加します。

例、いくつかのプラグインを有効にするには：

ikiwiki --changesetup 〜/ ikiwiki.setup --plugin goodstuff--プラグインカレンダー

--dumpsetup セットアップファイル
ikiwikiに指定されたセットアップファイルへの書き込みを行わせ、現在のセットアップファイルをダンプします
構成。

-ラッパー
--setup --refreshと一緒に使用すると、構成済みのラッパーも更新されます。

- 掃除
これにより、宛先で生成されたファイルがすべて削除され、ikiwikiがクリーンアップされます。
ディレクトリ、構成済みのラッパー、および.ikiwiki状態ディレクトリ。
これは、ビルドするMakefileでikiwikiを実行している場合に最も役立ちます
ドキュメントと対応するクリーンなターゲットが必要です。

--cgiCGIモードを有効にします。 cgiモードでは、ikiwikiはcgiスクリプトとして実行され、編集をサポートします
ページ、サインイン、および登録。

ikiwikiをCGIプログラムとして使用するには、-wrapperまたは--setupを使用して生成する必要があります。
ラッパー。 ラッパーは通常、suid6755を所有するユーザーに対して実行する必要があります。
ソースディレクトリと宛先ディレクトリ。

-ラッパー[ファイル]
他の人が指定したアクションを実行するようにハードコードされたラッパーバイナリを生成します
指定された入力ファイルと宛先ディレクトリを使用するオプション。 ファイル名
ラッパーの使用はオプションです。

ラッパーは、安全にsuidされ、信頼できないユーザーによって実行されるように設計されています。
コミット後のフック、またはCGIとして。

生成されたラッパーはすべてのコマンドラインパラメーターを無視することに注意してください。

- 集計
プラグイン/集計プラグインが有効になっている場合、これによりikiwikiポーリングが構成されます
新しい投稿をsrcdirにフィードして保存します。

以前に集約された投稿を再構築するには、一緒に--rebuildオプションを使用することに注意してください
これで。 --rebuildは、フィードがポーリングされていたとしても、強制的にポーリングされます。
最近ポーリングしました。

-ファイルをレンダリングします
単一のファイルをレンダリングし、結果のhtmlを出力します。 状態を保存しないので、これ
Wiki全体の構築には使用できませんが、編集済みのプレビューには役立ちます
コマンドラインでファイル。 通常、-setupと組み合わせて使用​​し、
ウィキの設定：

ikiwiki --セットアップ 〜/ ikiwiki.setup --foo.mdwnをレンダリングします

-コミット後
ポストコミットフックによって呼び出された場合と同じように、ポストコミットモードで実行します。 これは
おそらく、XNUMXつのホスト上のWebサーバーでikiwikiを使用する場合にのみ役立ちます。
別のリポジトリ。リポジトリの実際のコミット後フックがsshに接続できるようにします。
Webサーバーをホストし、手動でikiwikiを実行してWebサイトを更新します。

- バージョン
ikiwikiのバージョン番号を印刷します。

CONFIG OPTIONS

これらのオプションはwikiを構成します。 プラグインは追加の構成を追加できることに注意してください
独自のオプション。 これらすべてのオプションとその他のオプションは、を使用して構成することもできます。
セットアップファイル。

--wikiname名
ウィキの名前。デフォルトは「ウィキ」です。

--templatedir ディレクトリ
テンプレートが保存されるディレクトリを指定します。デフォルトは
/ usr / share / ikiwiki / templates、またはビルド時に構成された別の場所。 もしも
templatedirが変更されても、不足しているテンプレートは引き続き検索されます。
フォールバックとしてのデフォルトの場所。 テンプレートは「templates /」に配置することもできます
srcdirのサブディレクトリ。

ikiwikiのテンプレートをコピーして変更することを選択した場合は、次のことを行う必要があることに注意してください。
新しいバージョンのikiwikiにアップグレードするときは、それらを最新の状態に保つように注意してください。 年
テンプレートのバージョンは、新しいikiwikiバージョンで常に機能するとは限りません。

--underlaydir ディレクトリ
ソースディレクトリの下にあるディレクトリを指定します。 ソースファイル
ソースディレクトリ内のファイルによって上書きされない限り、ここから取得されます。
デフォルトは/ usr / share / ikiwiki / basewikiまたはビルド時に構成された別の場所です
時間。

-ラッパーモードモード
ラッパーを作成した後、ラッパーをchmodするモードを指定します。

-ラッパーグループグループ
ラッパーが所有するUNIXグループを指定します。 これは、次の場合に役立ちます。
ラッパーは、デフォルト以外のグループが所有している必要があります。 たとえば、
プロジェクトには、アクセスが制御される複数のコミッターを含むリポジトリがあります。
グループの場合、ikiwikiラッパーがそのグループに対してsetgidを実行することは理にかなっています。

--rcs = svn | git | ..、-no-rcs
Revision_control_systemの使用を有効または無効にします。

ソースディレクトリは、作業コピー、クローン、またはその他のものであると見なされます
選択したリビジョン管理システムが使用します。

CGIモードでは、リビジョン管理システムが有効になっているため、Web経由で編集されたページは
コミットします。

デフォルトでは、リビジョン管理は有効になっていません。

--svnrepo / svn / wiki
Wikiのsvnリポジトリの場所を指定します。

--svnpathトランク
wikiが配置されているsvnリポジトリ内のパスを指定します。 この
デフォルトはトランクです。 ウィキが内部の他のパスにある場合は変更してください
リポジトリ。 Wikiがリポジトリの上部にルートされている場合は、svnpathを「」に設定します。

--rss、-norss
rssが設定されている場合、ikiwikiはデフォルトでインラインのページのRSSフィードを生成します。
ブログ。

--allowss
allowrssが設定されていて、rssが設定されていない場合、ikiwikiはデフォルトでRSSを生成しません。
フィードしますが、インラインディレクティブでrss = yesを設定すると、このデフォルトをオーバーライドでき、
フィードを生成します。

--atom、-noatom
アトムが設定されている場合、ikiwikiはデフォルトでインラインのページのAtomフィードを生成します
a blog。

--allowatom
allowatomが設定されていて、rssが設定されていない場合、ikiwikiはデフォルトで生成されません
Atomはフィードしますが、インラインディレクティブでatom = yesを設定すると、このデフォルトをオーバーライドできます
フィードを生成します。

--pingurl URL
これをXML-RPCサービスのURLに設定して、RSSフィードが更新されたときにpingを実行します。 にとって
たとえば、Technoratiにpingを実行するには、URLを使用します http://rpc.technorati.com/rpc/ping

このパラメーターを複数回指定して、複数のURLを指定できます。
ping。

--url URL
WikiへのURLを指定します。 これは、CGIモードで必須のパラメーターです。

--cgiurl http://example.org/ikiwiki.cgi
ikiwikiCGIスクリプトラッパーへのURLを指定します。 構築時に必要
生成されるcgiスクリプトへのリンクのwiki。

--historyurl URL
ページ履歴を閲覧するためにリンクするURLを指定します。 URLでは、「[[file]]」は
参照するファイルに置き換えられます。 これにはViewVCを使用するのが一般的です。

--adminemail [メール保護]
ikiwikiがEメールの送信に使用するEメー​​ルアドレスを指定します。

--diffurl URL
ページへの変更の差分のためにリンクするURLを指定します。 URLで、
「[[file]]」は参照するファイルに置き換えられ、「[[r1]]」は古いリビジョンの
ページ、および「[[r2]]」は新しいリビジョンです。 これにはViewVCを使用するのが一般的です。

-正規表現を除外します
処理から除外するソースファイルのrexexpを​​指定します。 指定される場合があります
除外リストに追加するために複数回。

-正規表現を含める
通常は除外されるソースファイルのrexexpを​​指定しますが、
処理に含めたい。 含めるために追加するために複数回指定できます
リスト。

-管理者名
を持っているユーザー（または、openidが有効になっている場合はopenid）のユーザー名を指定します
ウィキ管理者の力。 現在、任意のページのロックとユーザーの禁止を許可しています。
有効なプラグインによって付与される権限（[[モデレート
コメント| plugins / moderatedcomments]]およびplugins / websetup。 指定される場合があります
複数の管理者に対して複数回。

openidユーザーの場合、「http：//」を含むログインの完全なURLを指定します。

-プラグイン名
Wikiで指定されたプラグインの使用を有効にします。 プラグイン名は
大文字と小文字を区別。

--disable-プラグイン名
プラグインの使用を無効にします。 たとえば、「-disable-pluginhtmlscrubber」を削除します
HTMLサニタイズを使用します。

--libdirディレクトリ
通常の場所の前に、指定されたディレクトリを最初にikiwikiが検索するようにします
ライブラリファイルとプラグインをロードするとき。 たとえば、libdirをに設定した場合
「/home/you/.ikiwiki/」では、foo.pmプラグインを次のようにインストールできます。
「/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm」。

--discussion、-no-discussion
「ディスカッション」リンクがすべてのヘッダーに追加されるのを有効または無効にします
ページ。 リンクはデフォルトで有効になっています。

--numbacklinks n
ページの下部に表示するバックリンクの数を制御します。 過剰
バックリンクはポップアップで非表示になります。 デフォルトは10です。これを無効にするには0に設定します
特徴。

--userdir サブディレクトリ
オプションで、ウィキのユーザーへのリンクが内部のページにリンクできるようにします
wikiのサブディレクトリ。 デフォルトでは、トップレベルディレクトリのページにリンクします
ウィキの。

--htmlext html
生成されたhtmlファイルに使用される拡張子を構成します。 デフォルトは「html」です。

--timeformat形式
時刻または日付の表示方法を指定します。 フォーマット文字列はに渡されます
ストラフタイム（3）機能。

--verbose、-no-verbose
何が行われているのかを詳しく説明します。

--syslog、-no-syslog
にログイン syslogとします。

--usedirs、-no-usedirs
page.htmlではなくpage / index.html（デフォルト）という名前の出力ファイルの作成を切り替えます。

--prefix-directives、-no-prefix-directives
Toggle new '！'-プリプロセッサディレクティブの接頭辞付き構文。 ikiwikiは現在
デフォルトは--prefix-directivesです。

--w3mmode、-no-w3mmode
w3mmodeを有効にします。これにより、w3mは、ローカルCGIスクリプトとしてikiwikiを使用できます。
Webサーバー。

--sslcookie
SSL接続を介してのみCookieを送信します。 これは彼らがいるのを防ぐはずです
傍受されました。 このオプションを有効にする場合は、少なくともCGI部分を実行する必要があります
SSLを介したikiwikiの。

--gettime、-no-gettime
リビジョンから新しいページごとに作成時間と変更時間を抽出します
コントロールのログ。 これは、初めてWikiを作成するときに自動的に行われます。
したがって、通常はこのオプションを使用する必要はありません。

--set var = value
これにより、設定した場合と同じように、任意の構成変数を設定できます。
セットアップファイルを介して。 最も一般的に使用されるオプションは、を使用して構成できるため
コマンドラインスイッチでは、これを使用する必要はほとんどありません。

--set-yaml var = value
これは--setに似ていますが、複雑なものを使用する構成変数を設定できます
YAMLドキュメントを渡すことによるデータ構造。

例

ikiwiki --setup my.setup

指定されたセットアップファイルを使用して、Wikiを完全に（再）ビルドします。

ikiwiki --setup my.setup --refresh
my.setupの設定を使用して、Wikiを更新し、次のようなページを再構築しないようにします。
変更されていません。 これはより高速です。

ikiwiki --setup my.setup --refresh --wrappers
すべてのラッパープログラムの再生成を含め、Wikiを更新しますが、再構築しないでください
すべてのページ。 セットアップファイルで変更していないものを変更した場合に便利です
すべてのページを更新するには、完全なwikiの再構築が必要ですが、すぐに実行したい
効果。

ikiwiki --rebuild srcdir destdir
srcdirをソースとして使用し、セットアップファイルを使用せずにdestdirでHTMLをビルドします。

ikiwiki srcdir 宛先ディレクトリ
ソースとしてsrcdirを使用して、destdirで変更されたページのHTMLを更新します。
セットアップファイル。

ENVIRONMENT

CC

これは、ラッパーのビルドに使用されるCコンパイラーを制御します。 デフォルトは「cc」です。

CFLAGSこれは、ラッパーをビルドするときにCコンパイラーにオプションを渡すために使用できます。

onworks.netサービスを使用してオンラインでikiwikiを使用する