Shell command projects/mkd

Version du 5 octobre 2017 à 14:28 (voir la source)

JPL (discuter | contributions)

m (→Manuel mkd en français : Ajout d'une section pour le manuel en espagnol)

← Modification précédente

Version du 5 octobre 2017 à 14:41 (voir la source)

JPL (discuter | contributions)

m (→Manuel mkd en espagnol : Ajout)

Modification suivante →

Ligne 288 :

-

=== ~~Manuel~~ mkd en ~~espagnol~~ ===

+

=== Manual mkd en espanol ===

-

+

-

~~Copier~~ le ~~contenu~~

+

MKD(1) Manual de usario Unix MKD(1)

+

Ultima actualizado hace 3 de octubre de, 2017

+

NOMBRE

+

mkd - make documentation. Generar (agregar) documentación. El programa

+

extrae la información codificada de los programas fuentes, y produce la

+

documentación especifica.

+

SINOPSIS

+

mkd [-ABCFPSafjlpstw] codigos ruta-de_origen [ruta-destino]

+

DESCRIPCIÓN

+

mkd Los comentarios seleccionados (o todos los comentarios) son

+

extraidos de los programas fuente ‘ruta-de_origen’ y son copia‐

+

dos en un fichero documental : ‘ruta-destino’, a fin de producir

+

una documentacion especifica. Por norma general los ficheros

+

documentales sont organigramas, estructuras de programa, comen‐

+

tarios para programadores, puntos de test y ‘alertas’ (warn‐

+

ings)… Los codigos a seleccionar pueden ser los siguientes :

+

‘O’, ‘S’,’P’,’T’ y ‘www’ justo despues del caracter delimitador.

+

codigos

+

Los comentarios que empiezen por estos caracteres son extraidos

+

del programa fuente y son anadidos al fichero documental. Todos

+

los caracteres ASCII pueden servir para codificar los comentar‐

+

ios, no obstante se suelen utilizar caracteres con mayusculas,

+

excepto W para ‘warning’. Con dos astericos en parametro codi‐

+

gos, mkd etrae todos los comentarios. (ver tambien opcion t y

+

los ejamplos)

+

ruta-de_origen

+

Ruta del archivo de fuente (o archive(fichero) proyecto: opción

+

j).

+

ruta-destino

+

Ruta del fichero documental. Por defecto ruta-destino es una

+

copia de ruta de origen al cual anadimos el sufijo por el sufijo

+

‘doc’

+

OPCIONES

+

Opciones de mayúsculas:

+

Limita la extraccion de los comentarios a un estilo de lenguaje

+

específico:

+

-A Extrae comentarios de estilo ensamblador (; al final de la

+

línea)

+

-B Estilo basico (REM o ' → final de la línea)

+

-C Estilo C ++ ( // → NL y /* → */ )

+

-F Estilo Fortran (c, C o * → final de la línea)

+

-P Estilo -P Pascal ( { → } y (* → *) )

+

-S Shell o estilo Ratfor ( # → final de la línea)

+

Lowercase options:

+

-a (append) Anade despues del fichero documental ruta destino.

+

-f (find) Encuentra un lenguaje del fichero fuente con el analisis

+

del sufijo. (útil con el archivo de proyecto). mkd reconoce los

+

siguientes archivos: .asm, .s; .bas, .vb, .bat; .C, .H, .D,

+

.cc, .hh, .cp, .cs, C #, .c ++, .h ++, c--, H-, .cpp, .hpp,

+

.css, .pr, .pl, .php, .jav, .js .JSE; .para, .f; .pas, .p;

+

.sh, .csh, .pl, .rb, .py, .pyw; .pj, .prj

+

-j (project) Se utiliza con un fichero proyecto compuesto de

+

fuentes de lenguajes diferentes.

+

-l (lines) Extrae las lineas que empiezan por los caracteres CD1 o

+

CD2 o CD3 y seguidos por caracteres codigos, el comentario se

+

acaba por la lectura del caracter ‘linea nueva’. CD1 y CD2 deben

+

estar en le primera columna, en vez de CD3 puede estar en el

+

medio de la linea. CD1, CD2, CD3, son opciones compilables en el

+

fichero version.h de la distribucion de origen de mkd. Se pueden

+

conocer estas opciones compiladas por mkd \?

+

-n (num) Enumera las líneas (número de línea del archivo fuente)

+

-p (page) Extrae el texto que empieze por el caracter CD4 seguido

+

de uno de los caracteres de codigos. La extraccion del comen‐

+

tario se acaba con la lectura del caracter CD5. CD4 y CD5 son

+

opciones compiladas en el fichero version.h de la distribucion

+

de origen de MKD. Se pueden conocer estas opciones compiladas

+

por mkd \?

+

-s (screen, verbose) Duplica los comentarios extraidos en la salida

+

-t (text) Solamente copia en comentario

+

-w (overwrite) Escribe de nuevo el fichero documental.

+

EJEMPLOS

+

con el comando shell:

+

mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz

+

Producto manual de UNIX para los usuarios franceses.

+

mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz

+

Manual de UNIX del producto.

+

mkd -Csl '*Sied' mkd3.c '*.verif_struct'

+

Documentación del producto con la estructura del programa,

+

incluye, define, ifdef cosa y endif opciones de compilación,

+

para verificar estructura del programa. (con opciones compil‐

+

ables CD1 = '#' o CD2 = '#' en version.h de distribución mkd).

+

mkd -jfsl '*OHie' mkd_docu.prj mkd.org

+

Organigrama del producto. Comentarios empezar *, O, H y archivos

+

de fuentes se enumeran en el archivo de proyecto. (con opciones

+

compilables CD1 = '#' o CD2 = '#'). f: encontrar un lenguaje,

+

j: archivo de origen es un archivo de proyecto que contiene la

+

lista de archivos de fuentes.

+

mkd -l '*ide' mkd3.c '*.id_ei'

+

(con opciones compilables CD1 = '#' o CD2 = '#', líneas de

+

extracto: #include, #define, #ifdef, #else, #endif, etc.)

+

mkd -pj '**' mkd_docu.prj mkd.strings

+

Extraer cadenas de programa. (mensajes se imprimen en stdout).

+

(archivos de fuentes están detallar en el archivo de proyecto y

+

con compilable Opciones CD4=CD5=´\"´). Extract strings from

+

program. (messages are printed to stdout). (sources files are

+

itemize in project file, and with compilable options

+

CD4=CD5=´\"´).

+

mkd (sin argumento)

+

Causa cualquier error y la sintaxis se transmiten al terminal

+

con los caracteres compilados para utilizar opciones l y p.

+

VER TAMBIÉN

+

mkdcppw(1)

+

HISTORIA

+

1986 - MKD para DOS y mkdoc para UNIX, se Escrito en formato ASCII

+

Jean-Paul Louyot para el laboratorio de la Universidad de Montpellier

+

"CEM" (Francia).

+

1991 - mkdoc 3.12 para PC y UNIX (Sun)

+

1995 - 2004 - mkdoc 3.22 a mkdoc 4 para Unix y Linux: SUN-SPARC, HP-UX,

+

RedHat

+

2004 - mkdoc 4 para Linux Ubuntu, Windows 98, Windows 2000

+

2007-2012 - mkdoc versión 7.01 para MKD R12.01 están en formato

+

ISO-8859-1. El nombre 'mkdoc' se abandona con el lanzamiento 10,01 com‐

+

pilado con Visual C ++ 2010

+

2012 - MKD 12.03 está adaptado a formato UTF-8 para traducciones y

+

internacionalización. En el mkdcppw estela se writen para decodificar

+

equipo C, C ++ y lenguajes PHP en modo gráfico con 'gcc' y 'gtkmm'.

+

DESCARGAS

+

http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX

+

AUTORES

+

Manual actualizado por Clara Jimenez, Cardabela, y el JPL.

+

TRADUCTORES

+

Spanish : Alizée Louyot, Claudie Favier

+

Email : http://edeulo.free.fr/contacts/formmail.php

+

NOTAS

+

Es pertenecen a los programadores para cerrar comentarios, bloques y

+

líneas, por los códigos de cierre apropiados en los archivos de origen.

+

Advertencia: El cierre de una línea de comentario es un retorno de

+

carro (NL, LF, CR / LF) según sea el caso.

+

Al final del archivo: esta nota implica un retorno de carro al final de

+

la línea de comentario. En este caso debe tener una línea en blanco al

+

final del archivo de origen.

+

No es que no permiten leer y decodificar los archivos incluidos por

+

#include en los archivos de fuentes.

+

FALLOS

+

Bugs Report: http://edeulo.free.fr/phpBB3/index.php

+

Documentos extrator

+

6 de Abril, 2016 MKD(1)

</pre>

Shell command projects/mkd

De Wiki EELL.

Version du 5 octobre 2017 à 14:41

Affichages

Outils personnels

Navigation

Rechercher

Boîte à outils

@@ Ligne 288 : / Ligne 288 : @@
 {{Boîte déroulante/fin}}
-=== Manuel mkd en espagnol ===
+=== Manual mkd en espanol ===
-{{Boîte déroulante/début|titre=mkd Manuel fr (11 Mai 2013)}}
+{{Boîte déroulante/début|titre=mkd Manual es (11 Mai 2013)}}
 <pre style="color:white;background-color:black;">
-Copier le contenu
+MKD(1)                       Manual de usario Unix                      MKD(1)
+                Ultima actualizado hace 3 de octubre de, 2017
+NOMBRE
+       mkd  - make documentation. Generar (agregar) documentación. El programa
+       extrae la información codificada de los programas fuentes, y produce la
+       documentación especifica.
+SINOPSIS
+       mkd [-ABCFPSafjlpstw] codigos ruta-de_origen [ruta-destino]
+DESCRIPCIÓN
+       mkd    Los  comentarios  seleccionados  (o  todos  los comentarios) son
+              extraidos de los programas fuente ‘ruta-de_origen’ y son  copia‐
+              dos en un fichero documental : ‘ruta-destino’, a fin de producir
+              una documentacion especifica. Por  norma  general  los  ficheros
+              documentales  sont organigramas, estructuras de programa, comen‐
+              tarios para programadores, puntos de  test  y  ‘alertas’  (warn‐
+              ings)…  Los  codigos  a  seleccionar pueden ser los siguientes :
+              ‘O’, ‘S’,’P’,’T’ y ‘www’ justo despues del caracter delimitador.
+       codigos
+              Los comentarios que empiezen por estos caracteres son  extraidos
+              del  programa fuente y son anadidos al fichero documental. Todos
+              los caracteres ASCII pueden servir para codificar los  comentar‐
+              ios,  no  obstante se suelen utilizar caracteres con mayusculas,
+              excepto W para ‘warning’. Con dos astericos en  parametro  codi‐
+              gos,  mkd  etrae  todos los comentarios. (ver tambien opcion t y
+              los ejamplos)
+       ruta-de_origen
+              Ruta del archivo de fuente (o archive(fichero) proyecto:  opción
+              j).
+       ruta-destino
+              Ruta  del  fichero  documental.  Por defecto ruta-destino es una
+              copia de ruta de origen al cual anadimos el sufijo por el sufijo
+              ‘doc’
+OPCIONES
+       Opciones de mayúsculas:
+              Limita  la extraccion de los comentarios a un estilo de lenguaje
+              específico:
+       -A     Extrae comentarios de estilo  ensamblador  (;  al  final  de  la
+              línea)
+       -B     Estilo basico               (REM o ' → final de la línea)
+       -C     Estilo C ++                 ( // → NL y  /*  →  */ )
+       -F     Estilo Fortran              (c, C o * → final de la línea)
+       -P     Estilo -P Pascal            ( {  →  } y (*  →  *)  )
+       -S     Shell o estilo Ratfor       ( #  →  final de la línea)
+       Lowercase options:
+       -a     (append) Anade despues del fichero documental ruta destino.
+       -f     (find)  Encuentra un lenguaje del fichero fuente con el analisis
+              del sufijo. (útil con el archivo de proyecto). mkd reconoce  los
+              siguientes  archivos:  .asm,  .s;  .bas, .vb, .bat;  .C, .H, .D,
+              .cc, .hh, .cp, .cs, C #, .c ++, .h  ++,  c--,  H-,  .cpp,  .hpp,
+              .css,  .pr,  .pl,  .php,  .jav, .js .JSE;  .para, .f;  .pas, .p;
+              .sh, .csh, .pl, .rb, .py, .pyw;  .pj, .prj
+       -j     (project) Se  utiliza  con  un  fichero  proyecto  compuesto  de
+              fuentes de lenguajes diferentes.
+       -l     (lines)  Extrae las lineas que empiezan por los caracteres CD1 o
+              CD2 o CD3 y seguidos por caracteres codigos,  el  comentario  se
+              acaba por la lectura del caracter ‘linea nueva’. CD1 y CD2 deben
+              estar en le primera columna, en vez de CD3  puede  estar  en  el
+              medio de la linea. CD1, CD2, CD3, son opciones compilables en el
+              fichero version.h de la distribucion de origen de mkd. Se pueden
+              conocer estas opciones compiladas por mkd \?
+       -n     (num) Enumera las líneas (número de línea del archivo fuente)
+       -p     (page)  Extrae  el texto que empieze por el caracter CD4 seguido
+              de uno de los caracteres de codigos. La  extraccion  del  comen‐
+              tario  se  acaba  con la lectura del caracter CD5. CD4 y CD5 son
+              opciones compiladas en el fichero version.h de  la  distribucion
+              de  origen  de  MKD. Se pueden conocer estas opciones compiladas
+              por mkd \?
+       -s     (screen, verbose) Duplica los comentarios extraidos en la salida
+       -t     (text) Solamente copia en comentario
+       -w     (overwrite) Escribe de nuevo el fichero documental.
+EJEMPLOS
+       con el comando shell:
+       mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
+              Producto manual de UNIX para los usuarios franceses.
+       mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
+              Manual de UNIX del producto.
+       mkd -Csl '*Sied' mkd3.c  '*.verif_struct'
+              Documentación del  producto  con  la  estructura  del  programa,
+              incluye,  define,  ifdef  cosa  y endif opciones de compilación,
+              para verificar estructura del programa.  (con  opciones  compil‐
+              ables CD1 = '#' o CD2 = '#' en version.h de distribución mkd).
+       mkd -jfsl '*OHie' mkd_docu.prj mkd.org
+              Organigrama del producto. Comentarios empezar *, O, H y archivos
+              de fuentes se enumeran en el archivo de proyecto.  (con opciones
+              compilables  CD1  = '#' o CD2 = '#').  f: encontrar un lenguaje,
+              j: archivo de origen es un archivo de proyecto que  contiene  la
+              lista de archivos de fuentes.
+       mkd -l '*ide' mkd3.c '*.id_ei'
+              (con  opciones  compilables  CD1  =  '#'  o CD2 = '#', líneas de
+              extracto: #include, #define, #ifdef, #else, #endif, etc.)
+       mkd -pj '**' mkd_docu.prj mkd.strings
+              Extraer cadenas de programa.  (mensajes se imprimen en  stdout).
+              (archivos  de fuentes están detallar en el archivo de proyecto y
+              con compilable Opciones  CD4=CD5=´\"´).   Extract  strings  from
+              program.  (messages  are printed to stdout).  (sources files are
+              itemize  in  project   file,   and   with   compilable   options
+              CD4=CD5=´\"´).
+       mkd (sin argumento)
+              Causa  cualquier  error  y la sintaxis se transmiten al terminal
+              con los caracteres compilados para utilizar opciones l y p.
+VER TAMBIÉN
+       mkdcppw(1)
+HISTORIA
+- MKD para DOS y mkdoc para UNIX,  se  Escrito  en  formato  ASCII
+       Jean-Paul  Louyot  para el laboratorio de la Universidad de Montpellier
+       "CEM" (Francia).
+- mkdoc 3.12 para PC y UNIX (Sun)
+- 2004 - mkdoc 3.22 a mkdoc 4 para Unix y Linux: SUN-SPARC, HP-UX,
+       RedHat
+- mkdoc 4 para Linux Ubuntu, Windows 98, Windows 2000
+-2012  -  mkdoc  versión  7.01  para  MKD  R12.01  están en formato
+       ISO-8859-1. El nombre 'mkdoc' se abandona con el lanzamiento 10,01 com‐
+       pilado con Visual C ++ 2010
+  -  MKD  12.03  está  adaptado a formato UTF-8 para traducciones y
+       internacionalización. En el mkdcppw estela se writen  para  decodificar
+       equipo C, C ++ y lenguajes PHP en modo gráfico con 'gcc' y 'gtkmm'.
+DESCARGAS
+       http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
+AUTORES
+       Manual actualizado por Clara Jimenez, Cardabela, y el JPL.
+TRADUCTORES
+       Spanish : Alizée Louyot, Claudie Favier
+       Email : http://edeulo.free.fr/contacts/formmail.php
+NOTAS
+       Es  pertenecen  a  los programadores para cerrar comentarios, bloques y
+       líneas, por los códigos de cierre apropiados en los archivos de origen.
+       Advertencia: El cierre de una línea de  comentario  es  un  retorno  de
+       carro (NL, LF, CR / LF) según sea el caso.
+       Al final del archivo: esta nota implica un retorno de carro al final de
+       la línea de comentario. En este caso debe tener una línea en blanco  al
+       final del archivo de origen.
+       No  es  que  no  permiten leer y decodificar los archivos incluidos por
+       #include en los archivos de fuentes.
+FALLOS
+       Bugs Report: http://edeulo.free.fr/phpBB3/index.php
+       Documentos extrator
+de Abril, 2016                         MKD(1)
 </pre>
 {{Boîte déroulante/fin}}