summaryrefslogtreecommitdiff
path: root/app/fvwm/docs/README
blob: 8432ce5863ca72884dc572e920ca09828842cb8b (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
54
55
56
57
58
Dan Espen, November 1, 1998.  No particular copyright attached.

This directory contains some of the fvwm2 documentation, including the
web pages that normally reside at the fvwm hosting site.

Unless you don't  have internet access, there  is no reason to install
these files at your site.

In this directory is the shell, txt2html.sh.  This is normally run
to take text files from the fvwm source distribution and turn them
into HTML.

Also   in  this directory is  the   shell run_man2html.sh.  This shell
invokes man2html which must be  separately installed.  (Special  fvwm2
sytle headers and colors are generated by the shell.)

As   a  release  is  shipped,  txt2html.sh   and run_man2html.sh would
normally be run in the directory where the resulting html is wanted.

This shell would be run for the files, NEWS, TODO, and FAQ.

This is  a description  of the  files  in this directory,  showing the
heirarchical structure of the web  pages.  Cross-reference type  links
from one page to another are not shown.


 README - This file
 black-stone1.jpg - Background for all the pages
 index.html - main page
   fvwm.gif - image, only used on index page
   download.html
   features.html
   mailinglist.html
   (mail archive not here, tool generated)
   docs.html
     (FAQ.html - txt2html.sh generated)
     (mail archive not here, tool generated)
     (TODO.html - txt2html.sh generated)
     (manual pages not here, tool generated)
     modules.html
       mod_changes.html
       mod_concept.html
       mod_security.html
       mod_initialization.html
       mod_m2f_communication.html
       mod_f2m_communication.html
   links.html
   (news.html - txt2html.sh generated)
 txt2html.sh - shell for converting text to html
 run_man2html.sh - shell for generating fvwm sytle man pages

Generated files:
 NEWS.html
 TODO.html
 FAQ.html

All the man pages need to be generated.  The need to be installed
before the html can be generated.  See run_man2html.sh.