ikiwiki — Online w chmurze

PROGRAM:

IMIĘ

ikiwiki — kompilator wiki

STRESZCZENIE

ikiwiki [opcje] miejsce docelowe źródła

ikiwiki --setup plik konfiguracyjny [opcje]

OPIS

ikiwiki to kompilator wiki. Tworzy statyczne strony HTML dla wiki, ze źródła w formacie
ikiwiki/język Markdown (lub inny) i zapisuje go w miejscu docelowym.

Zauważ, że większość opcji można skrócić do pojedynczych liter, flag boolowskich, takich jak --verbose
można zanegować za pomocą opcji --no-verbose, a opcje takie jak --verbose można również zapisywać podobnie
-gadatliwy.

TRYB OPCJE

Te opcje kontrolują tryb, w którym działa ikiwiki.

--odświeżać
Odśwież wiki, aktualizując wszelkie zmienione strony. Jest to zachowanie domyślne, jeśli nie
określona jest inna akcja trybu (ale zauważ, że --setup jest akcją trybu i ma
inne zachowanie domyślne).

--odbudować
Wymuś przebudowę wszystkich stron.

--setup plik instalacyjny
Załaduj opcje z podanego pliku instalacyjnego. Jeśli nie określono innej akcji trybu,
wygeneruj opakowania i przebuduj wiki, tak jakby użyto opcji --rebuild --wrappers. Jeśli
chcesz zbudować tylko zmienione strony, możesz użyć --refresh z --setup.

--changesetup plik instalacyjny
Odczytuje plik instalacyjny, dodaje wszelkie zmiany konfiguracji określone przez inne opcje,
i zapisuje nową konfigurację z powrotem do pliku instalacyjnego. Aktualizuje również dowolne
skonfigurowane opakowania. W tym trybie wiki nie jest w pełni przebudowywana, chyba że ty też
dodaj --rebuild.

Przykład, aby włączyć niektóre wtyczki:

ikiwiki --zmień ustawienia ~/ikiwiki.setup --plugin towary --plugin kalendarz

--dumpsetup plik instalacyjny
Powoduje, że ikiwiki zapisuje do określonego pliku instalacyjnego, wyrzucając jego bieżący
konfiguracja.

--opakowania
W przypadku użycia z opcją --setup --refresh powoduje to również aktualizację wszystkich skonfigurowanych opakowań.

--czysty
To sprawia, że ​​ikiwiki oczyszcza się, usuwając wszelkie pliki, które wygenerowała w miejscu docelowym
katalog, a także wszelkie skonfigurowane opakowania i katalog stanu .ikiwiki.
Jest to szczególnie przydatne, jeśli uruchamiasz ikiwiki w pliku Makefile do zbudowania
dokumentację i chcesz mieć odpowiedni czysty cel.

--cgi Włącz tryb CGI. W trybie cgi ikiwiki działa jako skrypt cgi i obsługuje edycję
strony, logowanie i rejestracja.

Aby używać ikiwiki jako programu CGI, musisz użyć --wrapper lub --setup do wygenerowania pliku
obwoluta. Wrapper zazwyczaj będzie musiał uruchomić suid 6755 do użytkownika, który jest właścicielem
katalogi źródłowe i docelowe.

--wrapper [plik]
Wygeneruj plik binarny opakowania, który jest zakodowany na stałe, aby wykonać akcję określoną przez drugą
opcje, używając określonych plików wejściowych i katalogu docelowego. Nazwa pliku do
użycie opakowania jest opcjonalne.

Wrapper został zaprojektowany tak, aby można go było bezpiecznie zainstalować i uruchamiać przez niezaufanych użytkowników, np
hak po zatwierdzeniu lub jako CGI.

Zauważ, że wygenerowane opakowanie zignoruje wszystkie parametry wiersza poleceń.

--agregat
Jeśli włączone są wtyczki/wtyczki agregujące, powoduje to skonfigurowanie ankiety ikiwiki
feeds i zapisuj nowe posty w katalogu srcdir.

Pamiętaj, że aby odbudować poprzednio zagregowane posty, użyj opcji --rebuild
z tym. --rebuild wymusi również odpytywanie kanałów, nawet jeśli były
ankietowane niedawno.

--renderuj plik
Renderuje pojedynczy plik, wyświetlając wynikowy HTML. Nie zapisuje stanu, więc to
nie może być używany do budowania całych wiki, ale jest przydatny do przeglądania edytowanego
plik w wierszu poleceń. Zwykle używane w połączeniu z opcją --setup do załadowania pliku a
konfiguracja wiki:

ikiwiki --ustawienia ~/ikiwiki.setup --render foo.mdwn

--po zatwierdzeniu
Uruchom w trybie po zatwierdzeniu, tak samo, jak w przypadku wywołania przez haka po zatwierdzeniu. To jest
prawdopodobnie przydatne tylko podczas korzystania z ikiwiki z serwerem WWW na jednym hoście i
repozytorium na innym, aby umożliwić rzeczywistemu hakowi po zatwierdzeniu repozytorium ssh
hosta serwera WWW i ręcznie uruchom ikiwiki, aby zaktualizować witrynę.

--wersja
Wydrukuj numer wersji ikiwiki.

CONFIG OPCJE

Te opcje konfigurują wiki. Pamiętaj, że wtyczki mogą dodawać dodatkową konfigurację
własne opcje. Wszystkie te opcje i więcej można również skonfigurować za pomocą
plik instalacyjny.

--nazwa wiki
Nazwa wiki, domyślna to „wiki”.

--templatedir reż
Określ katalog, w którym przechowywane są szablony. Domyślnie to
/usr/share/ikiwiki/templates lub inną lokalizację skonfigurowaną w czasie kompilacji. Jeśli
katalog szablonów zostanie zmieniony, brakujące szablony będą nadal wyszukiwane w katalogu
domyślna lokalizacja jako awaryjna. Szablony można również umieszczać w „templates/”
podkatalog srcdir.

Pamiętaj, że jeśli zdecydujesz się skopiować i zmodyfikować szablony ikiwiki, będziesz musiał to zrobić
uważaj, aby aktualizować je podczas aktualizacji do nowych wersji ikiwiki. Stary
wersje szablonów nie zawsze działają z nowymi wersjami ikiwiki.

--underlaydir reż
Określ katalog używany do podkładania katalogu źródłowego. Pliki źródłowe
zostanie pobrany stąd, chyba że zostanie zastąpiony przez plik w katalogu źródłowym.
Domyślnie jest to /usr/share/ikiwiki/basewiki lub inna lokalizacja skonfigurowana w build
czas.

--wrappertryb
Określ tryb chmodowania opakowania po jego utworzeniu.

--wrappergroup grupa
Określ, do której grupy uniksowej opakowanie powinno należeć. Może to być przydatne, jeśli
wrapper musi należeć do grupy innej niż domyślna. Na przykład, jeśli
projekt ma repozytorium z wieloma osobami zatwierdzającymi z dostępem kontrolowanym przez a
group, sensowne jest, aby opakowania ikiwiki uruchamiały setgid dla tej grupy.

--rcs=svn|git|.., --no-rcs
Włącz lub wyłącz użycie systemu kontroli_rewizji.

Zakłada się, że katalog źródłowy jest kopią roboczą, klonem lub czymkolwiek innym
używany jest wybrany system kontroli wersji.

W trybie CGI, z włączonym systemem kontroli wersji, strony edytowane przez Internet będą
być zobowiązanym.

Domyślnie żadna kontrola wersji nie jest włączona.

--svnrepo /svn/wiki
Określ lokalizację repozytorium svn dla wiki.

--svnpath pień
Określ ścieżkę wewnątrz repozytorium svn, w którym znajduje się wiki. Ten
domyślnie trunk; zmień to, jeśli twoja wiki znajduje się na innej ścieżce wewnątrz pliku
magazyn. Jeśli twoja wiki jest zrootowana na górze repozytorium, ustaw svnpath na „”.

--rss, --norss
Jeśli ustawiony jest rss, ikiwiki będzie domyślnie generować kanały RSS dla stron zawierających a
blog.

--pozwala
Jeśli opcja allowrss jest ustawiona, a rss nie jest ustawiona, ikiwiki nie będzie domyślnie generować RSS
feeds, ale ustawienie rss=yes w dyrektywie inline może zastąpić tę wartość domyślną i
wygenerować kanał.

--atom, --noatom
Jeśli ustawiono atom, ikiwiki będzie domyślnie generować kanały Atom dla stron, które są wbudowane
blog.

--allowatom
Jeśli ustawiona jest opcja allowatom, a rss nie jest ustawiona, ikiwiki nie będzie domyślnie generować
Kanały Atom, ale ustawienie atom=yes w dyrektywie wbudowanej może zastąpić tę wartość domyślną
i wygenerować kanał.

--pingurl Adres URL
Ustaw to na adres URL usługi XML-RPC, aby wysłać polecenie ping, gdy zostanie zaktualizowany kanał RSS. Dla
na przykład, aby pingować Technorati, użyj adresu URL http://rpc.technorati.com/rpc/ping

Ten parametr można określić wiele razy, aby określić więcej niż jeden adres URL
świst.

--adres URL
Określa adres URL do wiki. Jest to wymagany parametr w trybie CGI.

--cgiurl http://example.org/ikiwiki.cgi
Określa adres URL opakowania skryptu CGI ikiwiki. Wymagane podczas budowania
wiki, aby wygenerować linki do skryptu cgi.

--historyurl Adres URL
Określa adres URL, do którego ma prowadzić łącze do przeglądania historii strony. W adresie URL jest „[[plik]]”.
zastąpiony plikiem do przeglądania. Często używa się do tego ViewVC.

--administracja [email chroniony]
Określa adres e-mail, którego ikiwiki ma używać do wysyłania wiadomości e-mail.

--diffurl URL
Określa adres URL, do którego ma prowadzić łącze w celu porównania zmian na stronie. w adresie URL,
„[[plik]]” zostaje zastąpiony plikiem do przeglądania, „[[r1]]” to stara wersja
strona, a „[[r2]]” to nowa wersja. Często używa się do tego ViewVC.

--wyklucz wyrażenie regularne
Określa rexexp plików źródłowych, które mają zostać wykluczone z przetwarzania. Można określić
wiele razy, aby dodać do listy wykluczeń.

--włącz wyrażenie regularne
Określa rexexp plików źródłowych, które normalnie zostałyby wykluczone, ale ty
chcesz włączyć do przetwarzania. Można określić wiele razy, aby dodać do uwzględnienia
lista.

--admin nazwa użytkownika
Określa nazwę użytkownika (lub, jeśli openid jest włączony, openid), który ma
uprawnienia administratora wiki. Obecnie umożliwia blokowanie dowolnej strony i banowanie użytkowników, jak
a także uprawnienia przyznane przez włączone wtyczki (takie jak [[moderating
komentarze|wtyczki/moderowane komentarze]] i wtyczki/websetup. Można określić
wiele razy dla wielu administratorów.

W przypadku użytkownika openid podaj pełny adres URL logowania, w tym „http://”.

--nazwa wtyczki
Umożliwia korzystanie z określonej wtyczki na wiki. Pamiętaj, że nazwy wtyczek są
wielkość liter ma znaczenie.

--wyłącz nazwę wtyczki
Wyłącza korzystanie z wtyczki. Na przykład „--disable-plugin htmlscrubber”, aby usunąć
z oczyszczaniem HTML.

--libdir katalog
Sprawia, że ​​ikiwiki najpierw szuka w określonym katalogu, przed zwykłymi lokalizacjami
podczas ładowania plików bibliotek i wtyczek. Na przykład, jeśli ustawisz libdir na
„/home/you/.ikiwiki/”, możesz zainstalować wtyczkę foo.pm jako
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--dyskusja, --brak-dyskusji
Włącza lub wyłącza dodawanie linków „Dyskusja” do nagłówka każdego
strona. Linki są domyślnie włączone.

--numbacklinks rz
Kontroluje, ile linków zwrotnych powinno być wyświetlanych na dole strony. Nadmiar
linki zwrotne będą ukryte w wyskakującym okienku. Wartość domyślna to 10. Ustaw na 0, aby to wyłączyć
cecha.

--userdir podkatalog
Opcjonalnie pozwala linkom do użytkowników wiki na linkowanie do stron w a
podkatalog wiki. Domyślnie jest to łącze do stron w katalogu najwyższego poziomu
z wiki.

--htmldodatkowy html
Konfiguruje rozszerzenie używane dla generowanych plików html. Domyślnie jest to „html”.

--format czasu
Określ sposób wyświetlania godziny lub daty. Ciąg formatu jest przekazywany do
strftime.(3) funkcja.

--pełne, --bez-pełne
Mów szczegółowo o tym, co się dzieje.

--syslog, --no-syslog
Zaloguj się do syslog(3).

--usedirs, --no-usedirs
Przełącz tworzenie plików wyjściowych o nazwie page/index.html (domyślnie) zamiast page.html.

--dyrektywy-przedrostkowe, --no-dyrektywy-przedrostkowe
Przełącz nową składnię z prefiksem „!” dla dyrektyw preprocesora. obecnie ikiwiki
domyślnie --prefix-directives.

--w3mmmode, --no-w3mmmode
Włącz w3mmode, który pozwala w3m używać ikiwiki jako lokalnego skryptu CGI, bez a
serwer internetowy.

--sslcookie
Wysyłaj pliki cookie tylko przez połączenie SSL. Powinno to uniemożliwić im bycie
przechwycony. Jeśli włączysz tę opcję, musisz uruchomić przynajmniej część CGI
ikiwiki przez SSL.

--gettime, --no-gettime
Wyodrębnij czasy tworzenia i modyfikacji dla każdej nowej strony z wersji
dziennik kontroli. Odbywa się to automatycznie podczas tworzenia wiki po raz pierwszy,
więc normalnie nie musisz używać tej opcji.

--set var=wartość
Pozwala to na ustawienie dowolnej zmiennej konfiguracyjnej, takiej samej jak gdyby była ustawiona
przez plik instalacyjny. Ponieważ najczęściej używane opcje można skonfigurować za pomocą
przełączniki wiersza poleceń, rzadko będziesz musiał z tego korzystać.

--set-yaml var=wartość
To jest jak --set, ale pozwala ustawić zmienne konfiguracyjne, które używają złożonych
struktury danych, przekazując dokument YAML.

PRZYKŁADY

ikiwiki --konfiguruj moje.ustawienia

Całkowicie (ponownie) zbuduj wiki przy użyciu określonego pliku instalacyjnego.

ikiwiki --konfiguruj moje.ustawienia --odśwież
Odśwież wiki, używając ustawień z my.setup i unikaj przebudowywania stron, które to robią
nie zmieniły się. To jest szybsze.

ikiwiki --setup my.setup --refresh --wrappers
Odśwież wiki, łącznie z regeneracją wszystkich programów opakowujących, ale nie odbudowuj
wszystkie strony. Przydatne, jeśli zmieniłeś coś w pliku instalacyjnym, czego nie ma
potrzebujesz pełnej przebudowy wiki, aby zaktualizować wszystkie strony, ale chcesz to zrobić natychmiast
efekt.

ikiwiki --rebuild srcdir destdir
Użyj srcdir jako źródła i zbuduj HTML w destdir, bez użycia pliku instalacyjnego.

katalog docelowy ikiwiki srcdir
Użyj srcdir jako źródła, aby zaktualizować kod HTML zmienionych stron w destdir, bez użycia a
plik instalacyjny.

ŚRODOWISKO

CC

To kontroluje, który kompilator C jest używany do tworzenia opakowań. Wartość domyślna to „cc”.

CFLAGS Może być używany do przekazywania opcji do kompilatora C podczas budowania wrapperów.

Korzystaj z ikiwiki online, korzystając z usług onworks.net