Shell command projects/mkd

De Wiki EELL.

Version du 6 juin 2012 à 17:34 (voir la source) JPL (discuter | contributions) m (→Docs : maj !!!) ← Modification précédente		Version du 7 juin 2012 à 10:58 (voir la source) JPL (discuter | contributions) m (→Docs : incusion du manuel anglais) Modification suivante →
Ligne 14 :		Ligne 14 :
	== Docs ==		== Docs ==
		+	{{Boîte déroulante/début|titre=Manual en}}
		+	MKD(1)
		+
		+
		+
		+	NAME
		+	mkd  -  make  documentation.  Extract coded informations from programs
		+	sources and product specific documentation.
		+
		+	SYNOPSIS
		+	mkd [-ABCFPSafjlpstw] char_codes path_source [path_target]
		+
		+	DESCRIPTION
		+	mkd
		+	Selected comments (or all comments) are extracted from programs
		+	sources and product specific documentation to target file. Usual
		+	target files are Organigrams, or Structure of programs, or  com‐
		+	ments  for  Programmers,  Warnings  and  Tests points .... Coded
		+	informations are respectively 'O', 'S', 'P', 'www', ant 'T' just
		+	after the comment character.
		+
		+	char_codes
		+	All  ASCII.  The comment are extracted if the comment begin with
		+	this character. With two star mkd extract all comments.
		+
		+	path_source
		+	Path source file (or project file: option j ).
		+
		+	path_target
		+	Path target file. Default, path target is  idendical  to  source
		+	file with extension ´.doc´ .
		+
		+	OPTIONS
		+	Uppercase options:
		+	restrict comments to one specific language:
		+
		+	-A    extract Assembler style comments ( ; to end of line )
		+
		+	-B    Basic style                (REM or ' -> end of line)
		+
		+	-C    C style                    (  / *    ->      * /  )
		+
		+	-F    Fortran style              (c,C or * -> end of line)
		+
		+	-P    Pascal style                (  {    ->      }    )
		+
		+	-S    Shell or ratfor style      (  #    -> end of line)
		+
		+	Lowercase options:
		+
		+	-a    append to current target file.
		+
		+	-f    find source file language. (useful with project file)
		+
		+	-j    used if source file is a project file.
		+
		+	-l    lines  (extract lines delimited by CD1 or CD2 in first colomn or
		+	CD3 in line, and next New-Line. CD1,  CD2,  CD3  are  compilable
		+	options in version.h from mkd distribution)
		+
		+	-p    page  (extract text delimited by CD4 and CD5 -begin with CD4 and
		+	end with CD5-. CD4, CD5 are compilable options in version.h from
		+	mkd distribution)
		+
		+	-s    add to screen. (verbose)
		+
		+	-t    text (copy only the comment).
		+
		+	-w    overwrite the current target file.
		+
		+	EXAMPLES
		+	with Cshell command:
		+
		+	mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
		+	Product UNIX manual for french users.
		+
		+	mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
		+	Product UNIX manual.
		+
		+	mkd -Csl '*Sied' mkd3.c  '*.verif_struct'
		+	Product  documentation  with  structure  of  program,  includes,
		+	defines, ifdef else and endif compile options, to verify  struc‐
		+	ture of program.  (with compilable options CD1='#' or CD2='#' in
		+	version.h from mkd distribution).
		+
		+	mkd -jfsl '*OHie' mkd_docu.prj mkd.org
		+	Product organigram. Comment begin with *,O,H, and sources  files
		+	are  itemize  in project file.  (with compilable options CD1='#'
		+	or CD2='#').
		+
		+	mkd -l '*ide' mkd3.c '*.id_ei'
		+	(with compilable options CD1='#' or CD2='#').
		+
		+	mkd -pj '**' mkd_docu.prj mkd.strings
		+	Extract strings from program. (messages are printed to  stdout).
		+	(sources  files are itemize in project file, and with compilable
		+	options CD4=CD5=´\"´).
		+
		+	mkd (without argument)
		+	Cause any error and syntax are transmit to terminal with  carac‐
		+	ters compiled to use options l and p.
		+
		+	AUTHOR
		+	JP LOUYOT, Clara JIMENEZ.
		+
		+	http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
		+
		+	NOTES
		+	No  match, for read and decode include files from sources files in this
		+	Release 12.03.0
		+
		+
		+	BUGS
		+	Bugs Report: http://edeulo.free.fr/phpBB3/index.php
		+
		+	Documents generator mkd
		+
		+
		+
		+
		+
		+	29 March 2012                          MKD(1)
		+
		+	{{Boîte déroulante/fin}}
		+
	{{Boîte déroulante/début|titre=Manuel fr}}		{{Boîte déroulante/début|titre=Manuel fr}}
	MKD(1)		MKD(1)

---

Version du 7 juin 2012 à 10:58