summaryrefslogtreecommitdiff
path: root/doc/docu.tmpl
blob: dfbef40a631f187cd920937e64e54a330010a583 (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
=head1 NAME

<?% UNLESS Name == 'General' %?>
XXV::MODULES::<?% Name %?>
<?% ELSE %?>
<?% Name %?>
<?% END %?>

<?% UNLESS Name == 'General' %?>
=head1 SYNOPSIS

  <?%
    IF Name.match('NEWS::');
        MODUL = "XXV::OUTPUT::${Name}";
    ELSE;
        MODUL = "XXV::MODULES::${Name}";
    END;
  %?>
  use <?% MODUL %?>
  my $auto = <?% MODUL %?>->new(
    -config => \$Config,
    -dbh    => \$DBH,
    -realbin=> \$RealBin,
  );

<?% ELSE %?>
  ./bin/xxvd [--kill] [--configfile file] [--docu targetdir]

<?% END %?>

=head1 DESCRIPTION

<?% Description %?>

=head1 CONFIGURATION

=over 4

<?% FOREACH prefname = Preferences.keys.sort %?>
<?% NEXT IF Preferences.$prefname.type == 'hidden' %?>

=item * <?% prefname %?>

<?% Preferences.$prefname.description %?>

=over 4

=item * default: <?% Preferences.$prefname.default %?>

=item * type: <?% Preferences.$prefname.type %?>

=item * required: <?% Preferences.$prefname.required ? "Yes" : "No" %?>

=back

<?% END %?>

=back

=head1 COMMANDS

=over 4

<?% FOREACH cmdname = Commands.keys.sort %?>
<?% NEXT IF Commands.$cmdname.hidden == 'yes' %?>

=item *  <?% cmdname %?> (<?% Commands.$cmdname.short %?>)

<?% Commands.$cmdname.description %?>

<?% END %?>

=back

=head1 REQUIREMENTS

=over 4

<?% FOREACH reqmod = Prereq.keys.sort %?>

=item *  <?% reqmod %?>

<?% Prereq.$reqmod %?>

<?% END %?>

=back

=head1 SEE ALSO

XXV

=cut