File: generatedHelp.english

package info (click to toggle)
dotfile 1%3A2.4-1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 5,472 kB
  • ctags: 523
  • sloc: tcl: 14,072; sh: 918; makefile: 177; lisp: 18; ansic: 7
file content (309 lines) | stat: -rw-r--r-- 21,483 bytes parent folder | download
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
## This file has been auto generated from makeman.tcl
## on date Sun Dec 12 13:09:53 CET 1999
##
##

proc createHelpPage {prefix} {
	global __help_ref __help_headers __BASEDIR __system
set __help_headers {{{How to use this help page} h1 1.4} {{Help page layout} h2 4.6} {{Introduction} h1 13.4} {{Navigating The Dotfile Generator } h1 20.4} {{The load page } h2 23.6} {{The detail page } h3 32.8} {{The configuration page } h2 39.6} {{Layout} h3 42.8} {{The ExtEntry } h2 55.6} {{Adding elements } h3 58.8} {{Cut Copy and Paste } h3 65.8} {{Index element } h3 73.8} {{FillOut} h2 79.6} {{Window } h2 84.6} {{Command } h2 89.6} {{Menus} h1 96.4} {{File } h2 99.6} {{Generate } h3 102.8} {{Regenerate } h3 105.8} {{Save } h3 108.8} {{Save As } h3 115.8} {{Export } h3 118.8} {{Reload } h3 123.8} {{Quit } h3 126.8} {{Setup } h2 129.6} {{Options } h3 132.8} {{Manage Save/Export Files } h3 145.8} {{Mail } h2 148.6} {{Help } h2 153.6} {{About } h3 156.8} {{Help Page } h3 159.8} {{How to use the output } h3 162.8} {{More information } h1 165.4}}
set __help_ref(navigating) {20.4}
set __help_ref(manuals) {165.4}
set __help_ref(scissors) {65.8}
set __help_ref(menu_helppage) {159.8}
set __help_ref(load_detail) {32.8}
set __help_ref(extentry_newElm) {58.8}
set __help_ref(extentry_index) {73.8}
set __help_ref(menu_reload) {123.8}
set __help_ref(menu_file) {99.6}
set __help_ref(menu_setup) {129.6}
set __help_ref(menu_about) {156.8}
set __help_ref(menu_mail) {148.6}
set __help_ref(menu_quit) {126.8}
set __help_ref(menu_saveas) {115.8}
set __help_ref(menu_generate) {102.8}
set __help_ref(menu_options) {132.8}
set __help_ref(window) {84.6}
set __help_ref(menus) {96.4}
set __help_ref(menu_howToUse) {162.8}
set __help_ref(menu_save) {108.8}
set __help_ref(configpage) {39.6}
set __help_ref(extentry) {55.6}
set __help_ref(menu_help) {153.6}
set __help_ref(menu_manage) {145.8}
set __help_ref(loadpage) {23.6}
set __help_ref(menu_export) {118.8}
set __help_ref(menu_regenerate) {105.8}
set __help_ref(command) {89.6}
$prefix insert end {1.  How to use this help page
In the Dotfile Generators help page you will find information about the Dotfile Generator, and it's behavior. Furthermore the modules may insert text, which will describe complicated features, which is difficult to describe on a single configuration page . 

1.1.  Help page layout
In the following list you'll see the different parts of the help page. 
Index list   In the index list you can see all the section headers in the help text. 
Help text   The help text is of course the box showing the actual help text. 
Left and Right arrows   These two buttons let you travel back and forth in your history list . This is just like you know them from you favorite web browser. 
Search String   In the entry at the bottom of the page you can can search for a string in the help text. The search is case insensitive and it will search from the current position in the help text. 
Up and Down arrows   These two arrows will bring you to the previous/next match in your search.
Note : This help file is also available via WWW 

2.  Introduction
The Dotfile Generator is a configuration tool, which let you configure those awful dotfiles almost every unix program has. For the Dotfile Generator to configure a given program, it needs a module. To see which modules are installed on your system, type dotfile without any arguments in your shell. 

To configure a program you will start the Dotfile Generator with the given module name as argument (as you already did). This will most likely bring up a load page , where you can select a predefined setup to load. When you've selected one, The Dotfile Generator will show a menu structure, which resembles a directory browser. This menu structure represent several configuration pages . The pages contains the actual configuration options, and when you've configured all to your hearts content, you will generate , which will result in a configuration file for the given program. 

The most important thing to know about The Dotfile Generator is that help is available all the time, just press the right mouse button over the element you wish to know more about, and help will be shown either in the help region at the button of the configuration page or in the help browser you are looking at. 

3.  Navigating The Dotfile Generator 
In this section a description can be found on the different elements/pages of The Dotfile Generator. If you read this continually, please bear in mind that the help description is written so it is self contained and can be referenced to from the different pages and menus in The Dotfile Generator. 

3.1.  The load page 
The load page, is the one which is shown, when you start The Dotfile Generator, or when you select Reload in the File menu. 

This page lets you (re)load a given setup, either one you have created yourself, one that came with The Dotfile Generator, or sometimes even the one which is located in your original dotfile. 

You may chose to load only some of the configuration pages or all the pages in the module. To select only some of the pages, click the Details button. 

If you came to this page, from the Reload menu, you may also choose to reset some of the pages, which means that all configuration on the given page(s) will be deleted. This is equivalent to pressing the Cancel button at startup. 

3.1.1.  The detail page 
On the Detail page, you can select which configuration pages to load, reload or reset. For export files you may choose either to merge the existing page with the one shown in the item, or you may overwrite the exiting page, with the one in the item. 

Merge means that elements of ExtEntries , will be merged, ie. the elements will be added to the elements of the ExtEntry. 

Overwrite means that the existing page will be totally overwritten. Both menu items and configuration pages are shown, and when selecting a menu item, you will (de)select all the items below this menu item. 

3.2.  The configuration page 
The configuration pages are the places where you configure your program. Only one page is visible at a time, though this page may have several Window widgets . 

3.2.1.  Layout
In the title bar of the window you can see which page you are configuring, this is very useful when you travel all the pages of the module. 

At the bottom of the page you can see which pages will be generated. See the setup menu for the different possibilities. 

Above this, you will see some text. This is the help region. All help for the configuration page is located there. When you enter the page, general information about the page is located there. Later when you press the right mouse button on one of the elements of the page, you will see the help associated with this element in the help region. 

The rest of the page is configuration options. These are built from entries, check buttons, pull down menus, combo boxes and list boxes. For further information on these elements, please refer to the user manual . 

There are a few extra elements, however, which are specific for The Dotfile Generator, and they will be described below. 



3.3.  The ExtEntry 
The ExtEntry is an element, which repeats other elements several times. It is used for configurations, which the user may have zero, one or many of. Your search path in the shell is a good example of this sort of information. You may have a number of directories, in which the shell may search for executables. 

3.3.1.  Adding elements 
To add a new tuple to an extentry, you have to press the button, which look like this: 

This will also locate the new element in the view of the ExtEntry. 



3.3.2.  Cut Copy and Paste 
The tuples in the ExtEntry may be treated just like they were basic elements. Under the icon which look like this: is located a pull down menu with the following items: 
Cut   This will copy the tuple to the clipboard, and remove it from the ExtEntry. 
Copy   This will copy the tuple to the clipboard, and leave it in the ExtEntry. 
Paste   This will copy the tuple from the clipboard into the ExtEntry, just before the one in which the scissors was invoked. 
Insert Blank   This will insert an empty tuple, just before the one in which the scissors was invoked.


3.3.3.  Index element 
An ExtEntry may be arbitraryly big, by that reason some of them have an index element. This index element is used to travel to an other tuple in the ExtEntry, without having to scroll all the way to it. 

If an ExtEntry has an index element, a button which look like this: 
is located next to it. If you press this button a listbox will show up, and in it you can select the index element associated with the tuple you want to go to. When you've selected one, The Dotfile Generator will scroll the ExtEntry to this tuple. 

3.4.  FillOut
The FillOut widget is used to type some text, which is built from tokens and ordinary text. An example of this is the prompt in your shell. 

It is composed by a listbox and an entry. In the entry you can type ordinary text and insert tokens from the listbox within this text. The elements of the listbox may either be a basic token, or may be a configurable one. The configuration is, of course, done with basic Dotfile Generator widgets. 

3.5.  Window 
The configurations on one configuration page, may be located in several windows. This is especially useful, inside ExtEntries . 

A window widget is just a button, which brings up the window when it's pressed. 

3.6.  Command 
In addition to The Dotfile Generator's standard widget, there may be added some additional widgets, which all bring up a configuration page. At this moment the following widgets exists: 
Color Widget   This widget will let you select a color, either by name or by dragging three scales representing the three basic colors: red, green and blue. 
Font Widget   Here you select a font, either by name or by it's basic attributes (font name, font size etc.) 
File/Directory Browser   This is an ordinary browser, which you surely know from other applications.


4.  Menus
At the top of the main window, there is located three pull down menus. These contain links to different actions, configuration pages and help pages. The menus may be torn off, which is done by selecting the dashes at the top of the pull down menu. 

4.1.  File 


4.1.1.  Generate 
This is the most important function in The Dotfile Generator. This is the one which converts your configurations to the code of the program you are configuring. The code will be shown in a window and written to file(s). This can however be configured in the setup menu . To see how to use the output, please refer to the section below 

4.1.2.  Regenerate 
To generate a large module may take awhile. This delay will be annoying, if you play around with the different options on a page. To avoid this, you can regenerate the single page you are working on, and let the other part of the configuration file be. To do this you have to generate the whole module first! 

4.1.3.  Save 
This will save your configuration in a file, which lets you continue your configuration in a later Dotfile Generator session. 

You can (re)load the save files from the load menu 

This format is version dependent (both The Dotfile Generator version and module version). It is however very fast compared to the export format . 

4.1.4.  Save As 
This will save your configuration to the file you specify. 

4.1.5.  Export 
This will export your configuration to an export format. This format is version independent. However it is very slow to import from. So this format should only be used, if you want to upgrade your Dotfile Generator, or give your configuration to someone who uses The Dotfile Generator. (ver 2.0 or later.) 

The export format is also used if the module has a filter, which can convert from the original dotfile to configuration in The Dotfile Generator. 

4.1.6.  Reload 
This will let you reload /reset one or more configuration pages . 

4.1.7.  Quit 
This will quit The Dotfile Generator. If you have any unsaved changes, you will be offered to save these. 

4.2.  Setup 


4.2.1.  Options 
In the options menu you can configure how The Dotfile Generator behaves. It contains the following options: 
Name of the file(s) to generate to.   At the top of the setup window you can specify which file(s) to generate to, and the comment character for the given file. 
What to generate.   Next you can select where you want the generated code to go: Either in file(s), in window(s) on the screen, or both. 
How much to generate.   You can specify how many pages you which to generate: 
One page.   The Dotfile Generator will only generate the current visible configuration page. This is useful, if you experiment with The Dotfile Generator, to see what it generates for the different widgets. 
Selected pages.   The Dotfile Generator will only generated the pages, which you select. The selection is done at the bottom of the configuration page . 
All pages.   All the configuration pages are generated. 
Generate Defaults?   Some of the programs configured by The Dotfile Generator has default values, which is set when the option is not specified at all in the configuration file. If you append the output from The Dotfile Generator to the original configuration file, then this is useful to ensure that the settings in The Dotfile Generator will overwrite the original, which may be located in your configuration file. 
Save when Generating.   When you generate your module, you'll often want to save too. Here you can tell The Dotfile Generator to do this for you automatically. 
Place windows.   If your window manager asks you to place the windows, you may tell The Dotfile Generator that it shall place them for you. This may be useful...


4.2.2.  Manage Save/Export Files 
This will let you configure the header and description on the save- and export files. 

4.3.  Mail 
You can mail either a suggestion/comment, a bug report, or a postcard from The Dotfile Generator. 

The postcard is only for encouraging the programmers to make their job even better, after all... if no one is using our product, we may not want to spend so much time on it. 

4.4.  Help 


4.4.1.  About 
This will bring up a window with version information about The Dotfile Generator and the current module. 

4.4.2.  Help Page 
This will bring up this help page. 

4.4.3.  How to use the output 
This is a link into the help page, which the module programmer has written. It should tell you how to use the output from the current module. 

5.  More information 
The Dotfile Generator has a home page , which you may wish to check out. A manual on how to write modules for The Dotfile Generator is also available on the net. 

A mailing list exists for The Dotfile Generator. You may subscribe by sending a mail to dotfile-request@imada.sdu.dk with the subject subscribe. To unsubscribe, let the subject be unsubscribe.
}
label $prefix.img1 -bitmap @$__BASEDIR/Generator/bitmaps/new.xbm
$prefix window create 59.87 -window $prefix.img1
label $prefix.img2 -bitmap @$__BASEDIR/Generator/bitmaps/scissors.xbm
$prefix window create 66.115 -window $prefix.img2
label $prefix.img3 -bitmap @$__BASEDIR/Generator/bitmaps/idx.xbm
$prefix window create 76.68 -window $prefix.img3
$prefix tag configure rmedium240 -font {-*-helvetica-medium-r-*-*-*-240-*-*-*-*-*-*}
$prefix tag add rmedium240 1.0 1.29 13.0 13.16 20.0 20.37 96.0 96.9 165.0 165.21
$prefix tag configure rmedium180 -font {-*-helvetica-medium-r-*-*-*-180-*-*-*-*-*-*}
$prefix tag add rmedium180 4.0 4.22 23.0 23.20 32.0 32.24 39.0 39.29 42.0 42.14 55.0 55.19 58.0 58.24 65.0 65.27 73.0 73.22 79.0 79.13 84.0 84.13 89.0 89.14 99.0 99.11 102.0 102.17 105.0 105.19 108.0 108.13 115.0 115.16 118.0 118.15 123.0 123.15 126.0 126.13 129.0 129.12 132.0 132.16 145.0 145.33 148.0 148.11 153.0 153.11 156.0 156.14 159.0 159.18 162.0 162.30
$prefix tag configure omedium140 -font {-*-helvetica-medium-o-*-*-*-140-*-*-*-*-*-*}
$prefix tag add omedium140 8.80 8.92 14.254 14.261 18.218 18.229 24.99 24.105 24.113 24.117 30.35 30.41 30.204 30.210 33.129 33.134 33.196 33.205 61.45 61.49 70.35 70.40 80.30 80.34 106.80 106.91
$prefix tag configure rbold140 -font {-*-helvetica-bold-r-*-*-*-140-*-*-*-*-*-*}
$prefix tag add rbold140 5.71 6.11 6.85 7.10 7.77 8.22 8.158 9.14 9.199 10.19 11.0 11.4 66.170 67.4 67.82 68.5 68.80 69.6 69.126 70.13 90.186 91.13 91.157 92.12 92.109 93.23 133.108 134.36 134.161 135.18 135.137 136.22 136.78 137.10 137.207 138.16 138.153 139.11 139.56 140.19 140.417 141.22 141.160 142.15 168.126 168.133
$prefix tag configure rmedium140 -font {-*-helvetica-medium-r-*-*-*-140-*-*-*-*-*-*}
$prefix tag add rmedium140 1.29 2.257 4.22 5.71 6.11 6.85 7.10 7.77 8.22 8.80 8.92 8.158 9.14 9.199 10.19 11.0 11.4 11.48 13.16 14.254 14.261 18.218 18.229 18.313 20.37 21.298 23.20 24.99 24.105 24.113 24.117 30.35 30.41 30.204 30.210 30.230 32.24 33.129 33.134 33.196 33.205 37.207 39.29 40.160 42.14 53.0 55.19 56.311 58.24 61.45 61.49 63.0 65.27 66.170 67.4 67.82 68.5 68.80 69.6 69.126 70.13 70.35 70.40 71.0 73.22 77.248 79.13 80.30 80.34 82.298 84.13 87.80 89.14 90.186 91.13 91.157 92.12 92.109 93.23 94.0 96.9 97.248 99.11 100.0 102.17 103.335 105.19 106.80 106.91 106.309 108.13 113.146 115.16 116.59 118.15 121.146 123.15 124.66 126.13 127.106 129.12 130.0 132.16 133.108 134.36 134.161 135.18 135.137 136.22 136.78 137.10 137.207 138.16 138.153 139.11 139.56 140.19 140.417 141.22 141.160 142.15 143.0 145.33 146.86 148.11 151.174 153.11 154.0 156.14 157.105 159.18 160.35 162.30 163.142 165.21 168.126 168.133 168.192
$prefix tag configure indent1 -lmargin1 {0}
$prefix tag configure indent1 -lmargin2 {25}
$prefix tag add indent1 5.71 10.95 66.170 70.102 90.186 93.100 133.108 142.161
$prefix tag configure indent2 -lmargin1 {25}
$prefix tag configure indent2 -lmargin2 {50}
$prefix tag add indent2 136.78 139.55
$prefix tag add tag0 2.236 2.254
$prefix tag configure tag0 -underline 1
$prefix tag bind tag0 <1> "help`gotoTag configpage"
$prefix tag add tag1 16.154 16.163
$prefix tag configure tag1 -underline 1
$prefix tag bind tag1 <1> "help`gotoTag loadpage"
$prefix tag add tag2 16.366 16.385
$prefix tag configure tag2 -underline 1
$prefix tag bind tag2 <1> "help`gotoTag configpage"
$prefix tag add tag3 16.505 16.513
$prefix tag configure tag3 -underline 1
$prefix tag bind tag3 <1> "help`gotoTag menu_generate"
$prefix tag add tag4 18.251 18.269
$prefix tag configure tag4 -underline 1
$prefix tag bind tag4 <1> "help`gotoTag configpage"
$prefix tag add tag5 28.39 28.58
$prefix tag configure tag5 -underline 1
$prefix tag bind tag5 <1> "help`gotoTag configpage"
$prefix tag add tag6 28.135 28.142
$prefix tag configure tag6 -underline 1
$prefix tag bind tag6 <1> "help`gotoTag load_detail"
$prefix tag add tag7 33.41 33.60
$prefix tag configure tag7 -underline 1
$prefix tag bind tag7 <1> "help`gotoTag configpage"
$prefix tag add tag8 33.91 33.103
$prefix tag configure tag8 -underline 1
$prefix tag bind tag8 <1> "help`gotoTag menu_export"
$prefix tag add tag9 35.29 35.39
$prefix tag configure tag9 -underline 1
$prefix tag bind tag9 <1> "help`gotoTag extentry"
$prefix tag add tag10 40.143 40.157
$prefix tag configure tag10 -underline 1
$prefix tag bind tag10 <1> "help`gotoTag window"
$prefix tag add tag11 45.73 45.87
$prefix tag configure tag11 -underline 1
$prefix tag bind tag11 <1> "help`gotoTag menu_setup"
$prefix tag add tag12 49.196 49.211
$prefix tag configure tag12 -underline 1
$prefix tag bind tag12 <1> "help`gotoTag manuals"
$prefix tag add tag13 85.115 85.125
$prefix tag configure tag13 -underline 1
$prefix tag bind tag13 <1> "help`gotoTag extentry"
$prefix tag add tag14 103.258 103.268
$prefix tag configure tag14 -underline 1
$prefix tag bind tag14 <1> "help`gotoTag menu_setup"
$prefix tag add tag15 103.317 103.334
$prefix tag configure tag15 -underline 1
$prefix tag bind tag15 <1> "help`gotoTag howToUse"
$prefix tag add tag16 111.41 111.50
$prefix tag configure tag16 -underline 1
$prefix tag bind tag16 <1> "help`gotoTag loadpage"
$prefix tag add tag17 113.130 113.143
$prefix tag configure tag17 -underline 1
$prefix tag bind tag17 <1> "help`gotoTag menu_export"
$prefix tag add tag18 116.10 116.14
$prefix tag configure tag18 -underline 1
$prefix tag bind tag18 <1> "help`gotoTag menu_save"
$prefix tag add tag19 124.18 124.24
$prefix tag configure tag19 -underline 1
$prefix tag bind tag19 <1> "help`gotoTag loadpage"
$prefix tag add tag20 124.44 124.63
$prefix tag configure tag20 -underline 1
$prefix tag bind tag20 <1> "help`gotoTag configpage"
$prefix tag add tag21 138.132 138.150
$prefix tag configure tag21 -underline 1
$prefix tag bind tag21 <1> "help`gotoTag configpage"
$prefix tag add tag22 141.76 141.80
$prefix tag configure tag22 -underline 1
$prefix tag bind tag22 <1> "help`gotoTag menu_save"
$prefix tag add tag23 163.10 163.14
$prefix tag configure tag23 -underline 1
$prefix tag bind tag23 <1> "help`gotoTag howToUse"
$prefix tag add tag24 11.44 11.47
$prefix tag configure tag24 -underline 1
$prefix tag bind tag24 <1> "startBrowser http://www.imada.sdu.dk/~blackie/dotfile/help.html"
$prefix tag add tag25 166.28 166.37
$prefix tag configure tag25 -underline 1
$prefix tag bind tag25 <1> "startBrowser http://www.imada.sdu.dk/~blackie/dotfile"
$prefix tag add tag26 166.75 166.105
$prefix tag configure tag26 -underline 1
$prefix tag bind tag26 <1> "startBrowser http://www.imada.sdu.dk/~blackie/dotfile/dotdotfiles/"
}