Mkd (Extracteur de documents)/Internationalisation des manuels/mkd-Manual (en)
Manuel de référence en langue anglaise
Reference manual in english
[modifier | modifier le wikicode]Install
[modifier | modifier le wikicode]mkd_en.1 April 6, 2013
Reference manual for the version mkd-0~120508
Copy the content of the box File : mkd_en.1 below in your UTF-8 text editor.
Save the file under mkd_en.1 and execute the makefile make -f English.mak.
- See also d'Exemple d'installation des manuels.
File : English.mak
# File : English.mak
# Syntax: sudo (or su) make -f English.mak
# Manual:
mkd_en.1.gz: mkd_en.1
# Compress
gzip -c mkd_en.1 > mkd_en.1.gz
# File: Read only
chmod 444 mkd_en.1.gz
# Install
echo "Install the standard English language"
cp -f mkd_en.1.gz /usr/share/man/man1/mkd.1.gz
File : mkd_en.1
Formated nroff for manuals in Unicode UTF-8
Readable in UTF-8 format with the command man .\mkd_en.1
Else it is readable in ASCII format with the command nroff -man mkd_en.1
.\" FILE manuals Update_mkd_en.1.txt to edit in UTF-8 format
.\" .
.\" Mise à jour par JPL le 1 avril 1989 dans version.h MKDOC.3
.\" Vérifications UTF-8 par Clara le 6 novembre 2012
.\" Mise à jour par Cardabela le 31 mars 2012
.\" Mise à jour par JPL le 6 avril 2013
.\" .
.TH MKD 1 "April 6, 2013"
.SH NAME
mkd \- make documentation. Extract coded informations from programs sources and product specific documentation.
.SH SYNOPSIS
.I mkd
.RB [\-ABCFPSafjlpstw]
.IR char_codes
.IR path_source
.RB [path_target]
.SH DESCRIPTION
.TP
.I 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 comments for Programmers, Warnings and Tests points .... Coded informations are respectively 'O', 'S', 'P', 'www', ant 'T' just after the comment character.
.TP
.I char_codes
All ASCII. The comment are extracted if the comment begin with this character. With two star mkd extract all comments.
.TP
.I path_source
Path source file (or project file: option j ).
.TP
.I path_target
Path target file. Default, path target is idendical to source file with extension \'.doc\' .
.SH OPTIONS
.TP
.I Uppercase options:
.B restrict comments to one specific language:
.IP \fB\-A\fP
extract Assembler style comments ( ; to end of line )
.IP \fB\-B\fB
Basic style ( REM or ' → end of line )
.IP \fB\-C\fB
C++ style ( // → NL and /\* * → *\// )
.IP \fB\-F\fB
Fortran style ( c,C or * → end of line )
.IP \fB\-P\fB
Pascal style ( { → } and (* → *) )
.IP \fB\-S\fB
Shell or ratfor style ( # → end of line )
.TP
.I Lowercase options:
.B
.IP \fB\-a\fB
append to current target file.
.IP \fB\-f\fB
find source file language. (useful with project file)
.IP \fB\-j\fB
used if source file is a project file.
.IP \fB\-l\fB
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). You can see these options compiled by the command mkd \\?
.IP \fB\-n\fB
numbering the lines (line number from source files)
.IP \fB\-p\fB
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). You can see these options compiled by the command mkd \\?
.IP \fB\-s\fB
add to screen. (verbose)
.IP \fB\-t\fB
text (copy only the comment).
.IP \fB\-w\fB
overwrite the current target file.
.SH EXAMPLES
.TP
.I with shell command:
.TP
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
Product UNIX manual for french users.
.TP
mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
Product UNIX manual.
.TP
mkd -Csl '*Sied' mkd3.c '*.verif_struct'
Product documentation with structure of program, includes, defines, ifdef else and endif compile options, to verify structure of program.
(with compilable options CD1='#' or CD2='#' in version.h from mkd distribution).
.TP
mkd -jfsl '*OHie' mkd_docu.prj mkd.org
Product organigram. Comment begin with *,O,H, and sources files are listed in project file.
(with compilable options CD1='#' or CD2='#'). f: find language, j: source file is a project file containing the list of sources files.
.TP
mkd -l '*ide' mkd3.c '*.id_ei'
(with compilable options CD1='#' or CD2='#', extract lines: #include, #define, #ifdef, #else, #endif, etc.)
.TP
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=\'\\"\').
.TP
mkd (without argument)
Cause any error and syntax are transmit to terminal with caracters compiled to use options l and p.
.SH SEE ALSO
.PP
mkdcppw(1)
.SH HISTORY
.PP
1986 - mkd for DOS, and mkdoc for UNIX, are writen in ASCII format by Jean-Paul Louyot for the Montpellier Universidad 'CEM' laboratory (France).
.TP
1991 - mkdoc 3.12 for PC and UNIX (Sun)
.TP
1995 - 2004 - mkdoc 3.22 to mkdoc 4 for Unix and Linux: SUN-SPARC, HP-UX, RedHat
.TP
2004 - mkdoc 4 for Linux Ubuntu, Windows 98, Windows 2000
.TP
2007-2012 - mkdoc release 7.01 to mkd R12.01 are in format ISO-8859-1. The name 'mkdoc' is abandoned with the release 10.01 compiled with Visual C++ 2010
.TP
2012 - mkd 12.03 is adapted to UTF-8 format for translations and internationalization. In the wake mkdcppw is writen to decode computer C, c++ and php languages in graphical mode with 'gcc' and 'gtkmm'.
.SH DOWNLOADS
.PP
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
.SH AUTHORS
.PP
man updated by Clara JIMENEZ, Cardabela, and JPL.
.SH TRANSLATORS
.PP
Catalan : Alizée
.TP
English : JPL, Cardabela
.TP
German : Clara, JPL, Martine
.TP
Italian : Luca
.TP
Spanish : Alizée, JPT, Sharo
.TP
Email : http://edeulo.free.fr/contacts/formmail.php
.IP
.SH NOTES
.PP
It belong to the programmers to close comments, blocks and lines, by the appropriate closing codes in the source files.
Warning: The closure of a comment line is a carriage-return (NL, LF, CR/LF) as the case.
At the end of the file: this note implies a carriage-return at the end of the comment line. In this case you must have a blank line at the end of the source file.
Do es not allow to read and decode the files included by #include in the sources files.
.SH BUGS
.PP
Bugs Report: http://edeulo.free.fr/phpBB3/index.php
Documents generator mkd
Manual
[modifier | modifier le wikicode]MKD(1) 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 ( // → NL and /* → */ )
-F Fortran style ( c,C or * → end of line )
-P Pascal style ( { → } and (* → *) )
-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). mkd rec‐
ognizes the following files: .asm, .s; .bas, .vb, .bat; .C, .H,
.D, .cc, .hh, .cp, .cs, c#, .c++, .h++, c--, h--, .cpp, .hpp,
.css, .pr, .pl, .php, .jav, .jse .js; .for, .f; .pas, .p; .sh,
.csh , .pl, .rb, .py, .pyw; .pj, .prj
-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). You can see these
options compiled by the command mkd \?
-n numbering the lines (line number from source files)
-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). You can see these options compiled by the
command mkd \?
-s add to screen. (verbose)
-t text (copy only the comment).
-w overwrite the current target file.
EXAMPLES
with shell 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 listed in project file. (with compilable options CD1='#' or
CD2='#'). f: find language, j: source file is a project file
containing the list of sources files.
mkd -l '*ide' mkd3.c '*.id_ei'
(with compilable options CD1='#' or CD2='#', extract lines:
#include, #define, #ifdef, #else, #endif, etc.)
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.
SEE ALSO
mkdcppw(1)
HISTORY
1986 - mkd for DOS, and mkdoc for UNIX, are writen in ASCII format by
Jean-Paul Louyot for the Montpellier Universidad 'CEM' laboratory
(France).
1991 - mkdoc 3.12 for PC and UNIX (Sun)
1995 - 2004 - mkdoc 3.22 to mkdoc 4 for Unix and Linux: SUN-SPARC, HP-
UX, RedHat
2004 - mkdoc 4 for Linux Ubuntu, Windows 98, Windows 2000
2007-2012 - mkdoc release 7.01 to mkd R12.01 are in format ISO-8859-1.
The name 'mkdoc' is abandoned with the release 10.01 compiled with
Visual C++ 2010
2012 - mkd 12.03 is adapted to UTF-8 format for translations and
internationalization. In the wake mkdcppw is writen to decode computer
C, c++ and php languages in graphical mode with 'gcc' and 'gtkmm'.
DOWNLOADS
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
AUTHORS
man updated by Clara JIMENEZ, Cardabela, and JPL.
TRANSLATORS
Catalan : Alizée
English : JPL, Cardabela
German : Clara, JPL, Martine
Italian : Luca
Spanish : Alizée, JPT, Sharo
Email : http://edeulo.free.fr/contacts/formmail.php
NOTES
It belong to the programmers to close comments, blocks and lines, by
the appropriate closing codes in the source files.
Warning: The closure of a comment line is a carriage-return (NL, LF,
CR/LF) as the case.
At the end of the file: this note implies a carriage-return at the end
of the comment line. In this case you must have a blank line at the end
of the source file.
Do es not allow to read and decode the files included by #include in
the sources files.
BUGS
Bugs Report: http://edeulo.free.fr/phpBB3/index.php
Documents generator mkd
May 11, 2013 MKD(1)