orgadoc_init_readmes(1)
NAME
- orgadoc_init_readmes - Try to generate readme.xml files
- for orgadoc automaticaly from documentation files (.pdf, .ps,
- ...)
SYNOPSIS
orgadoc_init_readmes [ -h ] [ -v ] [ -d ] directory
OPTIONS
- This program follows the usual GNU command line syntax,
- with long options starting with two dashes (`-'). A summary of
- options is included below.
- -h --help
- Show summary of options.
- -v --version
- Show version of program.
- -d --debug
- Enable verbose mode.
- directory
- Explore this directory to find documentation (.pdf,
- .ps, .ps.Z, ...)
DESCRIPTION
- This manual page briefly describes the
- orgadoc_init_readmes command.
- orgadoc_init_readmes explore a directory recursively to
- find documentation files (.pdf, .ps, .ps.Z, ...) and generates a
- readme.xml file per directory with informations extracted from
- file.
- Currently, orgadoc_init_readmes can extract :
- · title, author, number of pages, date from a pdf file
- · number of pages from a ps (or compressed ps) file
- Everything that could not be extracted from a document is
- writed as "FIXME" in readme.xml files. After generation, you need
- to hand edit generated readme.xml files.
- Some xml sections can not be discovered in document, this
- is the case of the "comment" and "summary" sections.
- orgadoc_init_readmes does not overwrite readme.xml file,
- it appends content at the end of the file. This is an important
- note, be carefull when you launch orgadoc_init_readmes many
- times.
SEE ALSO
orgadoc, orgadoc_cgi, orgadoc_add_docs
AUTHOR
- This manual page was written by Julien Lemoine <<speed
- blue@happycoders.org>>. Permission is granted to copy, dis
- tribute and/or modify this document under the terms of the GNU
- Free Documentation License, Version 1.2 or any later version pub
- lished by the Free Software Foundation; with no Invariant Sec
- tions, no Front-Cover Texts and no Back-Cover Texts.
31 March 2004 OR