summaryrefslogtreecommitdiff
path: root/autoopts/tpl/rc-sample.tpl
blob: f01d5068756156854fa5486525f3d514bd142278 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
[= AutoGen5 Template rc

# Time-stamp:      "2011-11-21 04:52:41 bkorb"

##  This file is part of AutoOpts, a companion to AutoGen.
##  AutoOpts is free software.
##  AutoOpts is Copyright (c) 1992-2012 by Bruce Korb - all rights reserved
##
##  AutoOpts is available under any one of two licenses.  The license
##  in use must be one of these two and the choice is under the control
##  of the user of the license.
##
##   The GNU Lesser General Public License, version 3 or later
##      See the files "COPYING.lgplv3" and "COPYING.gplv3"
##
##   The Modified Berkeley Software Distribution License
##      See the file "COPYING.mbsd"
##
##  These files have the following md5sums:
##
##  43b91e8ca915626ed3818ffb1b71248b COPYING.gplv3
##  06a1a2e4760c90ea5e1dad8dfaac4d39 COPYING.lgplv3
##  66a5cedaf62c4b2637025f049f9b826f COPYING.mbsd

=]
# [= (define prog-name (get "prog-name")) prog-name =] sample configuration file
#[=

IF (if (not (exist? "homerc"))
       (error "RC file samples only work for rc-optioned programs")  )

   (out-move (string-append "sample-"
                (if (exist? "rcfile") (get "rcfile")
                    (string-append (get "prog-name") "rc")  )
   )         )

   (set-writable)

   (exist? "copyright")
\=]
# This source file is copyrighted and licensed under the following terms:
#
[=
  CASE copyright.type                   =][=
  == ""   =][=
   (sprintf "#  %s copyright (c) %s %s - all rights reserved\n#  %s"
     prog-name (get "copyright.date") (get "copyright.owner")
     "licensing type not specified" )   =][=

  = note  =][= (prefix "#  "  (get "copyright.text")) =][=

  *       =][= (license-full (get "copyright.type") prog-name "#  "
                   (get "copyright.owner") (get "copyright.date")) =][=
  ESAC                                  =][=

ENDIF "copyright exists"                =][=

FOR flag                                =][=

  IF (not (or (exist? "documentation") (exist? "no-preset")))     =]

# [= name =] -- [= descrip =]
#
[= INVOKE emit-description =]
# Example:
#
#[= name =][=
    IF (exist? "arg-type")
  =]	[= (if (exist? "arg-default") (get "arg-default")
           (if (exist? "arg-name")    (get "arg-name")
               (get "arg-type")  ))     =][=
    ENDIF (exist? "arg-type")           =][=

  ENDIF (not (exist? "documentation"))  =][=

ENDFOR flag

= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =][=

DEFINE emit-description =][=
(out-push-new)          =][=

  IF (~* (get "arg-type") "key|set")
=]This configuration value takes a keyword as its argument[=

    IF (=* (get "arg-type") "set")

=] list.  Each entry turns on or off membership bits.  The bits are set by [=#
=]name or numeric value and cleared by preceding the name or number with an [=#
=]exclamation character ('!').  [=

    ELSE

=].  [=

    ENDIF

=]The available keywords are:  [=
            (join ", " (stack "keyword")) =].  [=

  ELIF (=* (get "arg-type") "num")
 =]This configuration value takes an integer number as its argument.  [=
    IF (exist? "scaled") =]That number may be scaled with a single letter [=#
=]suffix:  k/K/m/M/g/G/t/T  These will multiply the value by powers of [=#
=]1000 (lower case) or 1024 (upper case).  [=
    ENDIF   =][=

  ENDIF     =][=

  (define fill-txt (out-pop #t))
  (if (defined? 'fill-txt)
      (string-append

         (shell (string-append "while read line
         do echo ${line} | fold -s -w76 | sed 's/^/# /'
            echo '#'
         done <<'__EndOfText__'\n" fill-txt "\n__EndOfText__" ))

         "\n#\n"
  )   ) =][=

  (if (exist? "doc") (prefix "# " (get "doc"))) =][=

ENDDEF emit-description

=]