ikiwiki - Online en la nube

PROGRAMA:

NOMBRE

ikiwiki - un compilador de wiki

SINOPSIS

ikiwiki [opciones] destino de origen

ikiwiki --setup setupfile [opciones]

DESCRIPCIÓN

ikiwiki es un compilador de wiki. Crea páginas HTML estáticas para un wiki, a partir de la fuente en el
ikiwiki / Markdown language (u otros), y lo escribe en el destino.

Tenga en cuenta que la mayoría de las opciones se pueden acortar a letras simples, banderas booleanas como --verbose
se puede negar con --no-verbose, y opciones como --verbose también se pueden escribir como
-verboso.

MODO CAMPUS

Estas opciones controlan el modo en el que opera ikiwiki.

--actualizar
Actualice la wiki, actualizando las páginas modificadas. Este es el comportamiento predeterminado si no
Se especifica otra acción de modo (pero tenga en cuenta que --setup es una acción de modo y tiene
comportamiento predeterminado diferente).

--reconstruir
Fuerza una reconstrucción de todas las páginas.

--setup archivo de instalación
Cargue las opciones del archivo de instalación dado. Si no se especifica ninguna otra acción de modo,
generar envoltorios y reconstruir el wiki, como si se usaran --rebuild --wrappers. Si
solo desea crear las páginas modificadas, puede usar --refresh con --setup.

--archivo de configuración de cambio de configuración
Lee el archivo de configuración, agrega los cambios de configuración especificados por otras opciones,
y vuelve a escribir la nueva configuración en el archivo de instalación. También actualiza cualquier
envoltorios configurados. En este modo, la wiki no se reconstruye por completo, a menos que también
agregar --rebuild.

Ejemplo, para habilitar algunos complementos:

ikiwiki --cambiar configuración ~ / ikiwiki.setup --complemento de bienes --complemento de calendario

- archivo de configuración de dumpsetup
Hace que ikiwiki escriba en el archivo de instalación especificado, volcando su actual
configuración.

- envoltorios
Si se usa con --setup --refresh, esto hace que también actualice los contenedores configurados.

--limpio
Esto hace que ikiwiki se limpie eliminando los archivos que generó en el destino.
directorio, así como cualquier contenedor configurado, y el directorio de estado .ikiwiki.
Esto es principalmente útil si está ejecutando ikiwiki en un Makefile para compilar
documentación y desea un objetivo limpio correspondiente.

--cgi Habilita el modo CGI. En el modo CGI, ikiwiki se ejecuta como un script CGI y admite la edición.
páginas, inicio de sesión y registro.

Para usar ikiwiki como un programa CGI, debe usar --wrapper o --setup para generar un
envoltura. El contenedor generalmente necesitará ejecutar suid 6755 para el usuario que posee el
directorios de origen y destino.

--wrapper [archivo]
Genere un binario contenedor que esté codificado para realizar la acción especificada por el otro
opciones, utilizando los archivos de entrada y el directorio de destino especificados. El nombre de archivo a
el uso de la envoltura es opcional.

La envoltura está diseñada para ser realizada de forma segura y ejecutada por usuarios que no son de confianza, como
gancho posterior a la confirmación, o como CGI.

Tenga en cuenta que el contenedor generado ignorará todos los parámetros de la línea de comandos.

--agregar
Si el complemento / complemento agregado está habilitado, esto hace que la encuesta de ikiwiki esté configurada
feeds y guardar nuevas publicaciones en srcdir.

Tenga en cuenta que para reconstruir publicaciones agregadas previamente, use la opción --rebuild junto
Con este. --rebuild también forzará el sondeo de los feeds incluso si fueron
encuestado recientemente.

--render archivo
Genera un solo archivo, generando el html resultante. No guarda el estado, entonces esto
no se puede utilizar para crear wikis completos, pero es útil para obtener una vista previa de un
archivo en la línea de comando. Generalmente se usa junto con --setup para cargar en un
configuración de wiki:

ikiwiki --configuración ~ / ikiwiki.setup --render foo.mdwn

--post-compromiso
Ejecutar en modo posterior a la confirmación, igual que si lo llamara un gancho posterior a la confirmación. Este es
probablemente solo sea útil cuando se usa ikiwiki con un servidor web en un host y un
repositorio en otro, para permitir que el enlace posterior a la confirmación real del repositorio
el host del servidor web y ejecute manualmente ikiwiki para actualizar el sitio web.

--versión
Imprime el número de versión de ikiwiki.

CONFIG CAMPUS

Estas opciones configuran la wiki. Tenga en cuenta que los complementos pueden agregar configuración adicional
opciones propias. Todas estas opciones y otras más también se pueden configurar mediante un
archivo de instalación.

--nombre de wikiname
El nombre de la wiki, el predeterminado es "wiki".

--dir.templado
Especifique el directorio en el que se almacenan las plantillas. El valor predeterminado es
/ usr / share / ikiwiki / templates, u otra ubicación configurada en el momento de la compilación. Si
el templatedir ha cambiado, las plantillas que faltan se seguirán buscando en el
ubicación predeterminada como alternativa. Las plantillas también se pueden colocar en las "plantillas /"
subdirectorio del srcdir.

Tenga en cuenta que si elige copiar y modificar las plantillas de ikiwiki, deberá
tenga cuidado de mantenerlos actualizados cuando actualice a nuevas versiones de ikiwiki. Viejo
las versiones de las plantillas no siempre funcionan con las nuevas versiones de ikiwiki.

--underlaydir directorio
Especifique el directorio que se utiliza para subyacer al directorio de origen. Archivos fuente
se tomará de aquí a menos que sea reemplazado por un archivo en el directorio de origen.
El valor predeterminado es / usr / share / ikiwiki / basewiki u otra ubicación configurada en la compilación
en las transacciones.

--modo modo envoltorio
Especifique un modo para modificar el contenedor después de crearlo.

--grupo de envoltura
Especifique a qué grupo Unix debe pertenecer el contenedor. Esto puede resultar útil si el
El contenedor debe ser propiedad de un grupo que no sea el predeterminado. Por ejemplo, si un
El proyecto tiene un repositorio con múltiples confirmadores con acceso controlado por un
grupo, tiene sentido que los contenedores de ikiwiki ejecuten setgid en ese grupo.

--rcs = svn | git | .., --no-rcs
Habilite o deshabilite el uso de un revision_control_system.

Se asumirá que el directorio de origen es una copia de trabajo, un clon o lo que sea
el sistema de control de revisiones que seleccione utiliza.

En el modo CGI, con un sistema de control de revisión habilitado, las páginas editadas a través de la web
estar comprometido.

Ningún control de revisión está habilitado de forma predeterminada.

--svnrepo / svn / wiki
Especifique la ubicación del repositorio svn para la wiki.

--svnpath tronco
Especifique la ruta dentro de su repositorio svn donde se encuentra la wiki. Esta
por defecto es troncal; cámbielo si su wiki está en alguna otra ruta dentro del
repositorio. Si su wiki tiene sus raíces en la parte superior del repositorio, establezca svnpath en "".

--rss, --norss
Si se establece rss, ikiwiki generará de forma predeterminada fuentes RSS para las páginas que incorporan un
blog.

--permitido
Si allowrss está configurado y rss no está configurado, ikiwiki no generará RSS de forma predeterminada.
feeds, pero establecer rss = yes en la directiva en línea puede anular este valor predeterminado y
generar un feed.

--átomo, --noátomo
Si atom está configurado, ikiwiki generará por defecto feeds Atom para las páginas que en línea
un blog

--permitir átomo
Si allowatom está configurado y rss no está configurado, ikiwiki no generará por defecto
Atom feeds, pero configurar atom = yes en la directiva en línea puede anular este valor predeterminado
y generar un feed.

--pingurlURL
Establezca esto en la URL de un servicio XML-RPC para hacer ping cuando se actualice una fuente RSS. Para
ejemplo, para hacer ping a Technorati, use la URL http://rpc.technorati.com/rpc/ping

Este parámetro se puede especificar varias veces para especificar más de una URL para
silbido.

--URLURL
Especifica la URL de la wiki. Este es un parámetro obligatorio en el modo CGI.

--cgiurl http://example.org/ikiwiki.cgi
Especifica la URL del contenedor de script CGI de ikiwiki. Requerido al construir el
wiki para que se generen enlaces al script cgi.

--URL URL de la historia
Especifica la URL a la que enlazar para navegar por el historial de la página. En la URL, "[[archivo]]" es
reemplazado con el archivo para navegar. Es común usar ViewVC para esto.

--admincorreo [email protected]
Especifica la dirección de correo electrónico que debe usar ikiwiki para enviar correos electrónicos.

--dirección URL difusa
Especifica la URL a la que enlazar para ver una diferencia de cambios en una página. En la URL,
"[[archivo]]" se reemplaza con el archivo para examinar, "[[r1]]" es la revisión anterior del
página, y "[[r2]]" es la nueva revisión. Es común usar ViewVC para esto.

--excluir expresión regular
Especifica una rexexp de archivos de origen para excluir del procesamiento. Puede especificarse
varias veces para agregar a la lista de exclusión.

--incluye regexp
Especifica una rexexp de archivos fuente, que normalmente se excluirían, pero que
desea incluir en el procesamiento. Puede especificarse varias veces para agregar para incluir
lista.

--adminusernombre
Especifica un nombre de usuario de un usuario (o, si openid está habilitado, un openid) que tiene la
poderes de un administrador wiki. Actualmente permite bloquear cualquier página y prohibir a los usuarios, como
así como los poderes otorgados por complementos habilitados (como [[moderar
comentarios | complementos / comentarios moderados]] y complementos / configuración web. Puede especificarse
varias veces para varios administradores.

Para un usuario de openid, especifique la URL completa del inicio de sesión, incluido "http: //".

--nombre del complemento
Habilita el uso del complemento especificado en la wiki. Tenga en cuenta que los nombres de los complementos son
distingue mayúsculas y minúsculas.

--deshabilitar nombre del complemento
Desactiva el uso de un complemento. Por ejemplo, "--disable-plugin htmlscrubber" para eliminar
con desinfección HTML.

--directorio libdir
Hace que ikiwiki busque primero en el directorio especificado, antes de las ubicaciones normales
al cargar archivos de biblioteca y complementos. Por ejemplo, si configura libdir en
"/home/you/.ikiwiki/", puede instalar un complemento foo.pm como
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--discusión, --no-discusión
Habilita o deshabilita enlaces de "Discusión" para que no se agreguen al encabezado de cada
página. Los enlaces están habilitados de forma predeterminada.

--numbacklinks sustantivo, masculino—
Controla cuántos vínculos de retroceso se deben mostrar en la parte inferior de una página. Exceso
Los vínculos de retroceso se ocultarán en una ventana emergente. El valor predeterminado es 10. Establezca en 0 para deshabilitar este
.

--userdir subdirectorio
Opcionalmente, permite que los enlaces a los usuarios de la wiki enlacen a páginas dentro de un
subdirectorio de la wiki. El valor predeterminado es vincular a páginas en el directorio de nivel superior
de la wiki.

--htmltexto html
Configura la extensión utilizada para los archivos html generados. El valor predeterminado es "html".

- formato de formato de hora
Especifique cómo mostrar la hora o la fecha. La cadena de formato se pasa al
Strftime(3) función.

--detallado, --no-detallado
Sea detallado sobre lo que se está haciendo.

--syslog, --no-syslog
Iniciar sesión en syslog(3).

--useres, --no-usesirs
Alternar la creación de archivos de salida denominados page / index.html (predeterminado) en lugar de page.html.

--directivas-prefijo, --directivas-sin-prefijo
Alternar nueva '!' - sintaxis prefijada para directivas de preprocesador. ikiwiki actualmente
por defecto es --prefix-directives.

--w3mmode, --no-w3mmode
Habilite w3mmode, que permite que w3m use ikiwiki como un script CGI local, sin un
Servidor web.

--sslcookie
Envíe cookies únicamente a través de una conexión SSL. Esto debería evitar que se
interceptado. Si habilita esta opción, debe ejecutar al menos la parte CGI
de ikiwiki sobre SSL.

--gettime, --no-gettime
Extraiga los tiempos de creación y modificación para cada nueva página de la revisión.
registro de control. Esto se hace automáticamente cuando se crea una wiki por primera vez,
por lo que normalmente no es necesario utilizar esta opción.

--set var = valor
Esto permite establecer una variable de configuración arbitraria, igual que si estuviera configurada
a través de un archivo de instalación. Dado que las opciones más utilizadas se pueden configurar utilizando
interruptores de línea de comandos, rara vez necesitará usar esto.

--set-yaml var = valor
Esto es como --set, pero permite establecer variables de configuración que usan complejas
estructuras de datos, pasando un documento YAML.

EJEMPLOS

ikiwiki --setup mi.setup

(Re) construir completamente la wiki usando el archivo de instalación especificado.

ikiwiki --setup mi.setup --refresh
Actualice la wiki utilizando la configuración de my.setup y evite reconstruir las páginas que
No han cambiado. Esto es más rápido.

ikiwiki --setup my.setup --refresh --envolturas
Actualice la wiki, incluida la regeneración de todos los programas de envoltura, pero no la reconstruya
todas las páginas. Útil si ha cambiado algo en el archivo de instalación que no
necesita una reconstrucción completa de la wiki para actualizar todas las páginas, pero que desea tomar de inmediato
efecto.

ikiwiki --rebuild srcdir dirdestino
Use srcdir como fuente y compile HTML en destdir, sin usar un archivo de instalación.

ikiwiki srcdir destdir
Use srcdir como fuente para actualizar el HTML de las páginas cambiadas en destdir, sin usar un
archivo de instalación.

MEDIO AMBIENTE

CC

Esto controla qué compilador de C se usa para construir envoltorios. El valor predeterminado es 'cc'.

CFLAGS Esto se puede usar para pasar opciones al compilador de C cuando se construyen envoltorios.

Use ikiwiki en línea usando los servicios de onworks.net