ikiwiki - Online na nuvem

PROGRAMA:

NOME

ikiwiki - um compilador wiki

SINOPSE

ikiwiki [opções] destino de origem

ikiwiki --setup setupfile [opções]

DESCRIÇÃO

ikiwiki é um compilador wiki. Ele constrói páginas HTML estáticas para um wiki, a partir da fonte no
linguagem ikiwiki / Markdown (ou outros), e grava no destino.

Observe que a maioria das opções pode ser encurtada para letras únicas, sinalizadores booleanos como --verbose
pode ser negado com --no-verbose, e opções como --verbose também podem ser escritas como
-verboso.

MODA OPÇÕES

Essas opções controlam o modo em que o ikiwiki opera.

--refrescer
Atualize o wiki, atualizando todas as páginas alteradas. Este é o comportamento padrão se não
outra ação de modo é especificada (mas note que --setup é uma ação de modo, e tem
comportamento padrão diferente).

--reconstruir
Força uma reconstrução de todas as páginas.

--setup arquivo de configuração
Carregar opções do arquivo de configuração fornecido. Se nenhuma outra ação de modo for especificada,
gere wrappers e reconstrua o wiki, como se --rebuild --wrappers fosse usado. Se
você só deseja construir as páginas alteradas, você pode usar --refresh com --setup.

--changesetup arquivo de configuração
Lê o arquivo de configuração, adiciona quaisquer alterações de configuração especificadas por outras opções,
e grava a nova configuração de volta no arquivo de configuração. Também atualiza qualquer
Wrappers configurados. Neste modo, o wiki não é totalmente reconstruído, a menos que você também
adicione --reconstruir.

Exemplo, para habilitar alguns plug-ins:

ikiwiki --changesetup ~ / ikiwiki.setup --plugin mercadorias --plugin calendar

--dumpsetup arquivo de configuração
Faz com que o ikiwiki grave no arquivo de configuração especificado, despejando seu atual
configuração.

--embrulhos
Se usado com --setup --refresh, também atualiza quaisquer wrappers configurados.

--limpar
Isso faz com que o ikiwiki seja limpo, removendo todos os arquivos que ele gerou no destino
, bem como quaisquer wrappers configurados e o diretório de estado .ikiwiki.
Istoéútil principalmente se você estiver executando o ikiwiki em um Makefile para construir
documentação e deseja um alvo limpo correspondente.

--cgi Ativa o modo CGI. No modo cgi, o ikiwiki é executado como um script cgi e oferece suporte à edição
páginas, login e registro.

Para usar o ikiwiki como um programa CGI, você precisa usar --wrapper ou --setup para gerar um
embrulho. O wrapper geralmente precisará executar suid 6755 para o usuário que possui o
diretórios de origem e destino.

--wrapper [arquivo]
Gere um binário de invólucro que é codificado para fazer a ação especificada pelo outro
opções, usando os arquivos de entrada especificados e o diretório de destino. O nome do arquivo para
o uso do invólucro é opcional.

O wrapper é projetado para ser feito com segurança suid e executado por usuários não confiáveis, como um
gancho post-commit, ou como um CGI.

Observe que o wrapper gerado irá ignorar todos os parâmetros da linha de comando.

--agregar
Se o plug-in / plug-in agregado estiver habilitado, isso torna a pesquisa do ikiwiki configurada
alimenta e salva novas postagens no srcdir.

Observe que para reconstruir postagens previamente agregadas, use a opção --rebuild junto
com este. --rebuild também forçará os feeds a serem pesquisados, mesmo que fossem
pesquisado recentemente.

--render arquivo
Processa um único arquivo, gerando o html resultante. Não salva o estado, então este
não pode ser usado para construir wikis inteiros, mas é útil para visualizar um editado
arquivo na linha de comando. Geralmente usado em conjunto com --setup para carregar em um
configuração do wiki:

ikiwiki - configuração ~ / ikiwiki.setup --render foo.mdwn

--pós-commit
Execute no modo post-commit, o mesmo como se chamado por um gancho post-commit. Isto é
provavelmente só é útil ao usar ikiwiki com um servidor da web em um host e um
repositório em outro, para permitir que o verdadeiro gancho post-commit do repositório para ssh
o host do servidor da web e execute manualmente o ikiwiki para atualizar o site.

--versão
Imprime o número da versão do ikiwiki.

CONFIG OPÇÕES

Essas opções configuram o wiki. Observe que os plug-ins podem adicionar configurações adicionais
opções próprias. Todas essas opções e outras também podem ser configuradas usando um
arquivo de configuração.

--nome do wiki
O nome do wiki, o padrão é "wiki".

--templatedir diretório
Especifique o diretório em que os modelos são armazenados. O padrão é
/ usr / share / ikiwiki / templates, ou outro local conforme configurado no momento da construção. Se
o templatedir for alterado, os modelos ausentes ainda serão pesquisados ​​no
localização padrão como alternativa. Os modelos também podem ser colocados em "templates /"
subdiretório do srcdir.

Observe que se você optar por copiar e modificar os modelos do ikiwiki, você precisará ser
cuidado para mantê-los atualizados ao atualizar para novas versões do ikiwiki. Velho
As versões dos modelos nem sempre funcionam com as novas versões do ikiwiki.

--underlaydir diretório
Especifique o diretório usado como base do diretório de origem. Arquivos Fonte
será obtido a partir daqui, a menos que seja substituído por um arquivo no diretório de origem.
O padrão é / usr / share / ikiwiki / basewiki ou outro local conforme configurado na construção
tempo.

modo --wrappermode
Especifique um modo para fazer o chmod do wrapper após criá-lo.

--grupo wrappergroup
Especifique a qual grupo Unix o wrapper deve pertencer. Isso pode ser útil se o
o wrapper precisa pertencer a um grupo diferente do padrão. Por exemplo, se um
projeto tem um repositório com vários committers com acesso controlado por um
grupo, faz sentido que os invólucros do ikiwiki executem setgid para esse grupo.

--rcs = svn | git | .., --no-rcs
Habilite ou desabilite o uso de um revision_control_system.

O diretório de origem será considerado uma cópia de trabalho, ou clone, ou o que quer que seja
o sistema de controle de revisão que você selecionar usa.

No modo CGI, com um sistema de controle de revisão habilitado, as páginas editadas via web irão
estar comprometido.

Nenhum controle de revisão é habilitado por padrão.

--svnrepo / svn / wiki
Especifique a localização do repositório svn para o wiki.

--svnpath tronco
Especifique o caminho dentro do seu repositório svn onde o wiki está localizado. Esse
o padrão é tronco; altere-o se o seu wiki estiver em algum outro caminho dentro do
repositório. Se o seu wiki está enraizado no topo do repositório, defina svnpath como "".

--rss, --norss
Se o rss for definido, o ikiwiki irá, por padrão, gerar feeds RSS para páginas que incorporam um
blog.

--allowrss
Se allowrss estiver definido e rss não estiver definido, o ikiwiki não irá gerar RSS por padrão
feeds, mas definir rss = yes na diretiva inline pode substituir este padrão e
gerar um feed.

--atom, --noatom
Se atom estiver definido, o ikiwiki irá usar como padrão a geração de feeds Atom para páginas que inline
um blog.

--allowatom
Se allowatom estiver definido e rss não estiver definido, o ikiwiki não irá gerar como padrão
Feeds Atom, mas definir atom = yes na diretiva inline pode substituir esse padrão
e gerar um feed.

--pingurlURL
Defina como a URL de um serviço XML-RPC para executar ping quando um feed RSS for atualizado. Para
exemplo, para executar ping no Technorati, use o URL http://rpc.technorati.com/rpc/ping

Este parâmetro pode ser especificado várias vezes para especificar mais de um URL para
ping

--urlURL
Especifica o URL do wiki. Este é um parâmetro obrigatório no modo CGI.

--cgiurl http://example.org/ikiwiki.cgi
Especifica o URL para o wrapper de script CGI ikiwiki. Obrigatório ao construir o
wiki para links para o script cgi a ser gerado.

--historyurlURL
Especifica o URL para vincular para navegação no histórico da página. No URL, "[[arquivo]]" é
substituído pelo arquivo para navegar. É comum usar ViewVC para isso.

--adminemail [email protegido]
Especifica o endereço de e-mail que o ikiwiki deve usar para enviar e-mail.

--diffurlURL
Especifica a URL para vincular a uma comparação das alterações em uma página. No URL,
"[[arquivo]]" é substituído pelo arquivo a ser navegado, "[[r1]]" é a revisão antiga do
página, e "[[r2]]" é a nova revisão. É comum usar ViewVC para isso.

--excluir regexp
Especifica um rexexp de arquivos de origem para excluir do processamento. Pode ser especificado
várias vezes para adicionar à lista de exclusão.

--incluir regexp
Especifica um rexexp de arquivos de origem, que normalmente seriam excluídos, mas que você
deseja incluir no processamento. Pode ser especificado várias vezes para adicionar para incluir
Lista.

--nome do usuário administrador
Especifica o nome de usuário de um usuário (ou, se openid estiver habilitado, um openid) que tem o
poderes de um administrador wiki. Atualmente permite o bloqueio de qualquer página e banimento de usuários, como
bem como poderes concedidos por plug-ins habilitados (como [[moderando
comentários | plug-ins / comentários moderados]] e plug-ins / websetup. Pode ser especificado
várias vezes para vários administradores.

Para um usuário openid, especifique o URL completo do login, incluindo "http: //".

- nome do plug-in
Habilita o uso do plugin especificado no wiki. Observe que os nomes dos plugins são
maiúsculas e Minúsculas.

--disable-nome do plugin
Desativa o uso de um plugin. Por exemplo "--disable-plugin htmlscrubber" para acabar com
com sanitização de HTML.

diretório --libdir
Faz com que o ikiwiki procure no diretório especificado primeiro, antes dos locais regulares
ao carregar arquivos de biblioteca e plug-ins. Por exemplo, se você definir libdir para
"/home/you/.ikiwiki/", você pode instalar um plugin foo.pm como
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--discussion, --no-discuss
Habilita ou desabilita links de "Discussão" de serem adicionados ao cabeçalho de cada
página. Os links são habilitados por padrão.

--numbacklinks m
Controla quantos backlinks devem ser exibidos na parte inferior de uma página. Excesso
os backlinks serão ocultados em um pop-up. O padrão é 10. Defina como 0 para desativar isso
recurso.

--userdir subdiretório
Opcionalmente, permite links para usuários do wiki vincularem a páginas dentro de um
subdiretório do wiki. O padrão é vincular a páginas no diretório de nível superior
do wiki.

--htmlexthtml
Configura a extensão usada para arquivos html gerados. O padrão é "html".

--formato de hora
Especifique como exibir a hora ou data. A string de formato é passada para o
horário de trabalho(3) função.

--verbose, --não-verbose
Seja prolixo sobre o que está sendo feito.

--syslog, --no-syslog
Entrar para syslog(3).

--usedirs, --no-usedirs
Alterne a criação de arquivos de saída denominados page / index.html (padrão) em vez de page.html.

--prefix-directives, --no-prefix-directives
Alterne a nova sintaxe com prefixo '!' Para diretivas de pré-processador. ikiwiki atualmente
o padrão é --prefix-directives.

--w3mmode, --no-w3mmode
Habilite w3mmode, que permite ao w3m usar ikiwiki como um script CGI local, sem um
servidor web.

--sslcookie
Envie cookies apenas por meio de uma conexão SSL. Isso deve impedi-los de ser
interceptado. Se você habilitar esta opção, você deve executar pelo menos a parte CGI
de ikiwiki por SSL.

--gettime, --no-gettime
Extraia os tempos de criação e modificação para cada nova página da revisão
registro do controle. Isso é feito automaticamente ao construir um wiki pela primeira vez,
portanto, normalmente você não precisa usar esta opção.

--set var = value
Isso permite definir uma variável de configuração arbitrária, a mesma como se fosse definida
por meio de um arquivo de configuração. Uma vez que as opções mais comumente usadas podem ser configuradas usando
opções de linha de comando, você raramente precisará usar isso.

--set-yaml var = value
Isso é como --set, mas permite definir variáveis ​​de configuração que usam
estruturas de dados, passando em um documento YAML.

EXEMPLOS

ikiwiki --setup meu.setup

Completamente (re) construa o wiki usando o arquivo de configuração especificado.

ikiwiki --setup meu.setup --refresh
Atualize o wiki, usando as configurações de my.setup, e evite reconstruir quaisquer páginas que
não mudaram. Isso é mais rápido.

ikiwiki --setup meu.setup --refresh --wrappers
Atualize o wiki, incluindo a regeneração de todos os programas de wrapper, mas não reconstrua
todas as páginas. Útil se você tiver alterado algo no arquivo de configuração que não
precisa de uma reconstrução completa do wiki para atualizar todas as páginas, mas que você deseja tomar imediatamente
efeito.

ikiwiki --rebuild srcdir destino
Use srcdir como fonte e construa HTML em destdir, sem usar um arquivo de configuração.

ikiwiki srcdir destino
Use srcdir como fonte para atualizar o HTML das páginas alteradas em destdir, sem usar um
arquivo de configuração.

MEIO AMBIENTE

CC

Isso controla qual compilador C é usado para construir wrappers. O padrão é 'cc'.

CFLAGS Isso pode ser usado para passar opções para o compilador C ao construir wrappers.

Use ikiwiki online usando serviços onworks.net