orgadoc_init_readmes1
Try to generate readme.xml files for orgadoc automaticaly from documentation files (.pdf, .ps, ...)
Usage
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, ...)
Overview
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.
Releases
Unchanged in 2 releases since Debian 3.1 (Sarge).