Programmers :
=============
Jean-Paul Louyot <jeanpaullouyot@gmail.com>
Clara Jimenez <clara.jimenez2@gmail.com>
Edeulo <edeulo@free.fr>
Translators :
=============
de: Martine Thomas, Clara Jimenez, Jean-Paul Louyot
en: Luca Giaccino, Clara Jimenez, Jean-Paul Louyot.
es: Alizée Louyot, Jean-Paul Thomas, charo Thomas.
fr: Jean-Paul Louyot, Clara Jimenez
it: Luca Giaccino.
Thanks :
========
Thanks at Cardabela, J Clara, and Sabine Krenzer, for his papers on wikimedias.
See :
On wikibooks :
(fr) Mkd (Extracteur de documents)
On Wikipedias :
(en) Mkd (software)
(fr) Mkd (Commande unix)
On marjorie-wiki.de :
Thanks at 'Sabine Krenzer' (1.8.1965 - 4.6.2013),
Thanks at 'Johnny Controletti' and 'Reise Reise'
(de) http://marjorie-wiki.de/wiki/Mkd_(Kommandozeile)
© Copyright CEM2 1989, 1991, 1995, 1999 : CEM2 ; cem2.univ-montp2.fr
Free Software Foundation, Inc.
© Copyright EELL 2004, 2007, 2010, 2012, 2013 EELL <edeulo@free.fr>
European Copyright (C) EUPL
https://joinup.ec.europa.eu/software/page/eupl
EELL, Éditeurs Européens de Logiciels Libres.
Association à but non lucratif selon l'Article 11 de la convention
européenne des droits de l'homme.
Vous êtes libre de copier reproduire et distribuer l’application selon les
termes de la Licence EUPL totalement compatible avec la licence GNU.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AUTHORS:
© Contact: http://edeulo.free.fr/contacts/formmail.php
Designer: initial JP Louyot (JPL)
Binary updates : Jean-Paul Louyot, and Clara Jimenez.
PROJECT: mkd
mkd is a UNIX command to extract pre-encoded comments lines to generate the
software documentation according to ISO standards.
mkd is the abbreviation of make documentation. This command was originally
known under the name mkdoc (make documentation).
This command is not integrated into the standard distributions of Unix / Linux
INITIAL PROJECT:
mkdoc 1989 for MS-DOS and UNIX now obsolete. CEM - University of Montpellier II
ADMINISTRATIVE RECORD:
extractdoc 04/12/2009
FILES UPDATES:
Date: ../../1989 by JPL mkd Initial programming for MSDOS and UNIX on SUN
Date: ../../1991 by JPL mkdoc 3.12 for PC and UNIX
Date: ../../1995 by JPL mkdoc 3.22 for RED-HAT on LINUX
Date: ../../2004 by JPL mkdoc 4.00 for LINUX ubuntu
Date: 11/02/2010 by JPL Update for MS Visual C10 beta 2.
Date: ../../.... by JPL Transformation into independant function for mkdcpp.
Date: ../03/2012 by CLARA Update to UTF-8 format (C++)
Date: 02/05/2012 by CLARA Special adaptation for mkdcppw with gtkmm
Date: 10/03/2013 by JPL Rewrite in english (en) to facilitate the translations
Date: 30/04/2013 by GC Rewrite to correct End Of File control
Date: 03/05/2013 by JPL Resolve the EOF problem if the last block is open.
Date: 15/10/2013 by JPL Resolve the new package for ubuntu
Date: 15/12/2013 by CLARA rewrite a new debian package
Date: 15/05/2014 by EDEULO new package and with the maintainers utility mkddocu
Installation and Uninstall Instructions
***************************************
© Copyright CEM2 1986, 1991, 1995, 1999 : CEM2 ; cem2.univ-montp2.fr
Free Software Foundation, Inc.
© Copyright EELL 2004, 2007, 2010, 2012, 2013 EELL <edeulo@free.fr>
European Copyright (C) EUPL
https://joinup.ec.europa.eu/software/page/eupl
Copying and distribution of this files, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. This file is offered as-is,
without warranty of any kind.
The installation is more secure and better with debian packages on launchpad :
==============================================================================
Downloads informations and sources for debian systems :
http://edeulo.free.fr/wiki/index.php/Shell_command_projects/mkd
Installation with the debian tarball in a terminal :
====================================================
To install mkd binary :
-----------------------
sudo apt-get install mkd_<version>.deb
To uninstall : sudo apt-get uninstall mkd
To install mkddocu :
--------------------
sudo apt-get install mkd_<version>.all_deb
To uninstall : sudo apt-get uninstall mkd_<version>.all_deb
---
Note : As root user you can install mkd with the repository software
Installation with sources :
===========================
Unpack the original source tarball.
To install mkd (mkd_<version>.deb:
----------------
Go in src directory type the following command in a terminal :
sudo ./INSTALL.sh
Note : As root user you can click on the command INSTALL.sh
To uninstall : sudo ./UNINSTALL.sh
For testing in your directory :
./INSTALL.sh ~/mkd
To uninstall : type rm -f ~/mkd in your user directory
To install mkddocu (mkd_<version>.all_deb):
-------------------------------------------
Go in src-mkddocu directory type the following command in a terminal :
sudo ./INSTALL.sh
Note : As root user you can click on the command INSTALL.sh
To uninstall sudo ./UNINSTALL.sh
For testing in your directory :
make -d install DESTDIR=~/mkddocu
To uninstall : rm -f ~/mkddocu
# file: Makefile (Makefile pour version LINUX UNBUNTU 6) mise à jour janvier 2012 par Clara
# modifié par JPL le 30/03/2012, 3/12/2013, 31/12/2013 pour empaquetage
# Only for packaging. see also INSTALL.sh in src directory
#
# Attention: avant de compiler, il faut valider les options de compilation
# dans version.h (notamment version UNIX ou version PC, ainsi que la langue)
#
################################################
### UBUNTU version for packaging mkd_R_13.10 ###
################################################
PGM = mkd
SRC = src
BINDIR = usr/bin
BINMODE = 755
SRCS = $(SRC)/mkd.c $(SRC)/asm.c $(SRC)/basic.c $(SRC)/cpp.c $(SRC)/fortran.c $(SRC)/pascal.c $(SRC)/shell.c $(SRC)/tri.c
HDRS = $(SRC)/version.h $(SRC)/mkd.h $(SRC)/asm.h $(SRC)/basic.h $(SRC)/cpp.h $(SRC)/fortran.h $(SRC)/pascal.h $(SRC)/shell.c $(SRC)/find.inc.c $(SRC)/find.inc.h $(SRC)/tri.h
OBJS = mkd.o asm.o basic.o cpp.o fortran.o pascal.o shell.o tri.o
LIBS =
CFLAGS = -O
LDFLAGS =
SPLINTFLAG = -weak
$(PGM): $(SRCS) $(HDRS)
-@echo "*********** update $(PGM) ***********"
$(CC) $(CFLAGS) -o $(PGM) $(SRCS)
@#$(CC) $(LDFLAGS) -o $(PGM) $(OBJS) $(LIBS)
-@echo " -- update $(BINDIR)/$(PGM):"
-@if [ -d $(BINDIR) ]; then \
mv -f $(PGM) $(BINDIR)/$(PGM);\
chmod $(BINMODE) $(BINDIR)/$(PGM);\
else \
echo "couldn't find $(BINDIR)";\
fi
# La recompilation du binaire est nécessaire
install: mkd
mkdir -p debian/mkd/usr/bin
cp -rf usr debian/mkd/.
make -d -C src-mkddocu install DESTDIR=../debian/mkd-doc
# mrproper for CDBS
mrproper:
rm -rf *~
rm -f $(PGM) $(BINDIR)/$(PGM)
rm -f $(OBJS)
# clean for dh
clean :
rm -rf *~
rm -f $(PGM) $(BINDIR)/$(PGM)
rm -f $(OBJS)
This version 140515 of mkd :
- Includes mkddocu utility for maintainers
Version 2013-10-15 of mkd :
- Includes german documentation, and translated messages.
- English manual is updated.
Description :
=============
mkd is a UNIX command to extract pre-encoded comments lines to generate software
documentation according to ISO standards.
mkd is the abbreviation of make documentation. This command was originally known
under the name mkdoc (make documentation).
This command is not included into the standard distributions of Unix and Linux.
Bugs reports :
==============
http://edeulo.free.fr/phpBB3/viewforum.php?f=14
Usage, self updates: man, po, mo files, are written by user Cardabela on wikimedias :
=====================================================================================
See `Mkd (Extracteur de documents)` on wikibook.
See also `Mkd (Unix command)` on wikipedia (en).
or `Mkd (Commande unix)` on wikipedia (fr)
or `Mkd (Kommandozeile)` on http://marjorie-wiki.de (de)
Contacts :
==========
edeulo@free.fr
