---
name: "orgadoc_init_readmes"
section: "1"
platform: "linux"
package: "orgadoc"
version: "0.8-4"
release: "Debian 4.0 (Etch)"
platforms: ["linux"]
url: "https://new.carta.tech/orgadoc_init_readmes"
---

# orgadoc\_init\_readmes(1)

Try to generate readme.xml files for orgadoc automaticaly from documentation files (.pdf, .ps, ...)

## 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 \<\<speedblue@happycoders.org\>\>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts.