Web or console

Web usage

You need an operational web server (like Apache) with PHP 5 running on it.

Put directory phpsimpledoc/ somewhere visible by your web server.
Visit the corresponding page, for ex. http://localhost/path/to/phpsimpledoc/src/index.php.
A page containing a list of links should appear.
Clicking on one of these links orders phpSimpleDoc to generate the documentation of the corresponding program.

These links correspond to .ini files located by default in directory phpsimpledoc/user-directives/.
These .ini files contain the directives transmited to phpSimpleDoc. See page User directives for details.

To organize the programs to document, directory user-directives/ can have subdirectories, which permits to have sub-lists on index page.

If a file or a subdirectory starts by "z.", it is not listed in the index page ; this permits to archive, or temporarily disable useless commands without deleting them.

Use from command line

PHP CLI (Command Line Interface) must be installed on your machine.
There is no specific script for phpsimpledoc, but you can invoke it from a shell by :

php -f /path/to/phpsimpledoc/src/index.php path/to/command.ini

If you (stilll) use MS Windows, you may need to type something like :

c:\php\cli\php.exe -f /path/to/phpsimpledoc/src/index.php path/to/command.ini

or maybe without the -f (todo : check that)

c:\php\cli\php.exe /path/to/phpsimpledoc/src/index.php path/to/command.ini

path/to/command.ini can be :
- the absolute path to the .ini user directives file.
- the relative path to the .ini user directives file, from current directory (the directory where the command was issued).

This advantages of this solution are :
- You are not obliged to store the directives files under phpsimpledoc/user-directives/ directory
- Ability to order documentation via cron (scheduled tasks).