summaryrefslogtreecommitdiff
path: root/support/dosepsbin/README
blob: c03e55d85b75cd6abe079a099a4b76e4e9240da6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
README for dosepsbin 2012/03/22 v1.2

Copyright 2011-2012 by Heiko Oberdiek

License
=======
The file is part of project dosepsbin.
It's free software; you may redistribute it and/or
modify it under the same terms as Perl itself
(Perl Artistic License/GNU General Public License, version 2).

Requirements
============
* Perl

Documentation
=============
The source of the documentation is embedded as POD data
in the Perl script dosepsbin.pl. The documentation is
available in various formats:
* Manual page:    dosepsbin.man
* PDF file:       dosepsbin.pdf
* HTML file:      dosepsbin.html
* Text file:      dosepsbin.txt
And program option --man displays the documentation on
the screen.

Installation
============
* Unix:
  GNU autoconf was used, thus you can try:
    ./configure
    make install
  It should install the script and manual page.
  The other documentation files can be installed manually.

* Manually:
  * dosepsbin.pl: Install the file as `dosepsbin' in a directory
    that is listed in environment variable `PATH', e.g.
      /usr/local/bin/dosepsbin
  * dosepsbin.man: Install the manual page as `dosepsbin.1'
    in the appropriate directory, e.g.:
      /usr/local/man/man1/dosepsbin.1
  * dosepsbin.pdf, dosepsbin.html, dosepsbin.html, README:
    Install them where you find them, for example in directory:
      /usr/local/share/doc/dosepsbin/

The files clean-case.pl and version.pl are just helper scripts for
generating the documentation and are provided for sake of completeness.
They are usually not needed, because the documentation files are
already generated and provided in the distribution.

See the documentation for further information.