Imported Upstream version 1.46.4
[platform/upstream/help2man.git] / help2man.es.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
2 .TH HELP2MAN "1" "octubre 2014" "help2man 1.46.4" "Órdenes de usuario"
3 .SH NOMBRE
4 help2man \- genera una página de manual sencilla
5 .SH SINOPSIS
6 .B help2man
7 [\fI\,OPCIÓN\/\fR]... \fI\,EJECUTABLE\/\fR
8 .SH DESCRIPCIÓN
9 `help2man' genera una página de manual a partir de la salida de `\-\-help' y de `\-\-version'.
10 .TP
11 \fB\-n\fR, \fB\-\-name\fR=\fI\,CADENA\/\fR
12 descripción del párrafo NAME
13 .TP
14 \fB\-s\fR, \fB\-\-section\fR=\fI\,SECCIÓN\/\fR
15 número de sección de la página del manual (1, 6, 8)
16 .TP
17 \fB\-m\fR, \fB\-\-manual\fR=\fI\,TEXTO\/\fR
18 nombre del manual (órdenes de usuario, ...)
19 .TP
20 \fB\-S\fR, \fB\-\-source\fR=\fI\,TEXTO\/\fR
21 fuente del programa (FSF, Debian, ...)
22 .TP
23 \fB\-L\fR, \fB\-\-locale\fR=\fI\,CADENA\/\fR
24 selección local (predefinida "C")
25 .TP
26 \fB\-i\fR, \fB\-\-include\fR=\fI\,FICHERO\/\fR
27 incluir material de `FICHERO'
28 .HP
29 \fB\-I\fR, \fB\-\-opt\-include\fR=\fI\,FICHERO\/\fR incluir material de `FICHERO' si existe
30 .TP
31 \fB\-o\fR, \fB\-\-output\fR=\fI\,FICHERO\/\fR
32 enviar salida a `FICHERO'
33 .TP
34 \fB\-p\fR, \fB\-\-info\-page\fR=\fI\,TEXTO\/\fR
35 nombre de la página del manual Texinfo
36 .TP
37 \fB\-N\fR, \fB\-\-no\-info\fR
38 suprimir el puntero al manual Texinfo
39 .TP
40 \fB\-l\fR, \fB\-\-libtool\fR
41 excluir `lt\-' del nombre del programa
42 .TP
43 \fB\-\-help\fR
44 imprimir esta ayuda y, a continuación, salir
45 .TP
46 \fB\-\-version\fR
47 imprimir el número de versión y, a continuación, salir
48 .PP
49 EJECUTABLE debería aceptar las opciones `\-\-help' y `\-\-version' y sacar el resultado por
50 la salida estándar, aunque se pueden especificar alternativas utilizando:
51 .TP
52 \fB\-h\fR, \fB\-\-help\-option\fR=\fI\,CADENA\/\fR
53 CADENA para la opción de ayuda
54 .TP
55 \fB\-v\fR, \fB\-\-version\-option\fR=\fI\,CADENA\/\fR
56 CADENA para la opción de versión
57 .TP
58 \fB\-\-version\-string\fR=\fI\,CADENA\/\fR
59 CADENA para la versión
60 .TP
61 \fB\-\-no\-discard\-stderr\fR
62 incluir la salida estándar cuando se procese la opción output
63 .SH "FICHEROS DE INCLUSIÓN"
64 Puede añadirse material en la salida generada con las opciones
65 .B \-\-include
66 y
67 .B \-\-opt\-include.
68 El formato es muy simple:
69
70     [sección]
71     texto
72
73     /patrón/
74     texto
75
76 Los bloques de texto *roff literal se añaden a la salida, bien
77 al comienzo de la [ sección ] .BI indicada
78 (insensible a mayúsculas y minúsculas), bien despuñes de un párrafo que coincida con
79 .BI / patrón / \fR.
80
81 Los patrones utilizan la sintaxis de las expresiones regulares de Perl y pueden ir seguidos de
82 los modificadores
83 .IR i ,
84 .I s
85 o
86 .I m
87 (véase
88 .BR perlre (1)).
89
90 Las líneas situadas antes de la primera sección o patrón que empiezan por `\-' se
91 procesan como opciones.  El resto se ignora silenciosamente y puede utilizarse
92 como comentarios, claves RCS y cosas similares.
93
94 El orden en que salen las secciones (aquellas que estén incluidas) es:
95
96     NOMBRE
97     SINOPSIS
98     DESCRIPCIÓN
99     OPCIONES
100     ENTORNO
101     FICHEROS
102     EJEMPLOS
103     \fIotras\fR
104     AUTOR
105     INFORMAR DE ERRORES
106     COPYRIGHT
107     VÉASE TAMBIÉN
108
109 Todas las secciones
110 .B [NOMBRE]
111 o
112 .B [SINOPSIS]
113 que aparezcan en el fichero de inclusión reemplazan las que se hubieran
114 generado automáticamente (aunque se puede evitar lo
115 anterior con
116 .B \-\-name
117 si hace falta).
118
119 Otras secciones se insertan delante de la salida generada automáticamente para
120 las secciones estándar indicadas arriba o incuidas en
121 .I otras
122 (arriba) en el orden en que se encuentran en el fichero «include».
123
124 Puede indicarse explícitamente dónde colocar el texto dentro de la sección utilizando
125 la sintaxis
126 .RI [< sección ],
127 .RI [= sección ]
128 o
129 .RI [> sección ]
130 para colocar el texto adicional antes, en lugar de, o después de la salida
131 predefinida, respectivamente.
132 .SH DISPONIBILIDAD
133 La última versión de esta distribución está disponible en línea desde:
134
135     ftp://ftp.gnu.org/gnu/help2man/
136 .SH AUTOR
137 Escrito por Brendan O'Dea <boo@debian.org>
138 .SH "INFORMAR DE ERRORES"
139 Informar de errores a <bug\-help2man@gnu.org>.
140 .SH COPYRIGHT
141 Copyright \(co 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
142 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
143 .br
144 Esto es software libre; consulte el código fuente para ver las condiciones de copia.
145 SIN NINGUNA garantía, ni siquiera COMERCIAL ni de ADECUACIÓN PARA NINGÚN FIN PARTICULAR.
146 .SH "VÉASE TAMBIÉN"
147 La documentación completa de
148 .B help2man
149 se mantiene como manual Texinfo.  Si los programas
150 info .B
151 y
152 .B help2man
153 están adecuadamente instalados en su sistema, el comando
154 .IP
155 .B info help2man
156 .PP
157 debería darle acceso al manual completo.