1ROLLREC-EDITOR(1) User Contributed Perl Documentation ROLLREC-EDITOR(1)
2
6 rollrec-editor - DNSSEC-Tools Rollrec GUI Editor
7
9 rollrec-editor [options] <rollrec-file>
10
12 rollrec-editor provides the capability for easy GUI-based management of
13 rollrec files. A rollrec file contains one or more rollrec records.
14 These records are used by the DNSSEC-Tools rollover utilities (rollerd,
15 etc.) to describe zones' rollover state. Each zone's rollrec record
16 contains such information as the zone file, the rollover phase, and
17 logging level. rollrec files are text files and may be edited by any
18 text editor. rollrec-editor allows editing of only those records a
19 user should change and performs error checking on the data.
20 When rollrec-editor starts, a window is created that has "buttons" for
22 each rollrec record in the given rollrec file. (In this documentation,
23 this window is called the Button Window.) Clicking on the buttons
24 selects (or deselects) that zone. After one or more zones are
25 selected, one of several commands may be executed. Commands allow mod‐
26 ification and deletion of existing rollrec records, creation of new
27 rollrec records, merging of rollrec files, and verification of file
28 validity.
29 rollrec-editor's commands are available through the menus and most have
31 a keyboard accelerator. The commands are described below in the COM‐
32 MANDS section.
33 When a rollrec record is selected for modification, a new window is
35 created to hold the editable fields of the record. The fields may be
36 modified in place. When editing is complete, the record is "saved".
37 This does not save the modified rollrec into its on-disk file; the file
38 must be saved explicitly from the Button Window.
39 As stated above, verification checks are performed when saving an
41 edited rollrec record. One set of checks ensures that files and direc‐
42 tories associated with a zone actually exist. This check may be turned
43 off at command start-up with the -ignore-warns command line option. It
44 may be modified during execution with the "Ignore Edit Warnings" menu
45 command.
46 Button Window Layout
48 The Button Window contains a button for each rollrec record in the
50 selected file. The buttons are arranged in a table that with at least
51 three columns. The number of columns may be set at command start-up
52 with the -columns command line option. It may be modified during exe‐
53 cution with the "Columns in Button Window" menu command.
54 When setting the number of columns, rollrec-editor minimizes the space
56 required to display the selected file's rollrec buttons. This will
57 sometimes cause the number of columns to differ from that requested.
58 For example, assume a rollrec file has 12 rollrec records. The follow‐
60 ing table shows how many rows and columns are given for each of the
61 given column selections.
62 column count rows columns
64 1 12 1
65 2 6 2
66 3 4 3
67 4 3 4
68 5 3 4
69 6 2 6
70 7 2 6
71 8 2 6
72 9 2 6
73 10 2 6
74 11 2 6
75 12 1 12
76 The actual rows and columns for a requested column count will vary in
78 order to allow a "best-fit".
79 UNDOING MODIFICATIONS
81 The "undo" capability is not currently implemented.
83 rollrec-editor has the ability to reverse modifications it has made to
85 a rollrec file. This historical restoration will only work for modifi‐
86 cations made during a particular execution of rollrec-editor; modifica‐
87 tions made during a previous execution may not be undone.
88 After a "Save" operation, the data required for reversing modifications
90 are deleted. This is not the case for the "Save As" operation.
91
93 rollrec-editor supports the following options.
94 -columns columns
96 This option allows the user to specify the number of columns to be
97 used in the Button Window.
98 -ignore-warns
100 This option causes rollrec-editor to ignore edit warnings when per‐
101 forming validation checks on the contents of rollrec records.
102 -no-filter
104 This option turns off name filtering when rollrec-editor presents a
105 file-selection dialog for choosing a new rollrec file. If this
106 option is not given, then the file-selection dialog will only list
107 regular files with a suffix of .rrf.
108 -V This option displays the program and DNSSEC-Tools version.
110
112 rollrec-editor provides the following commands, organized by menus:
113 File, Edit, Commands, Rollrecs, and Options.
114 File Menu
116 The File Menu contains commands for manipulating rollrec files and
118 stopping execution.
119 Open
121 Open a new rollrec file. If the specified file does not exist, the
122 user will be prompted for the action to take. If the user chooses
123 the "Continue" action, then rollrec-editor will continue editing
124 the current rollrec file. If the "Quit" action is selected, then
125 rollrec-editor will exit.
126 Save
128 Save the current rollrec file. The data for the "Undo Changes"
129 command are purged, so this file will appear to be unmodified.
130 Nothing will happen if no changes have been made.
132 Save As
134 Save the current rollrec file to a name selected by the user.
135 Quit
137 Exit rollrec-editor.
138 Edit Menu
140 The Edit Menu contains commands for general editing operations.
142 Undo Changes
144 Reverse modifications made to the rollrec records. This is only
145 for the in-memory version of the rollrec file.
146 Not currently implemented.
148 Commands Menu
150 The Commands Menu contains commands for modifying rollrec records.
152 New Rollrec
154 Create a new rollrec record. The user is given a new window in
155 which to edit the user-modifiable rollrec fields. A button for the
156 new rollrec record will be inserted into the Button Window.
157 After editing is completed, the "Save" button will add the new
159 rollrec record to the in-memory rollrec file. The file must be
160 saved in order to have the new rollrec added to the file.
161 Potentially erroneous conditions will be reported to the user at
163 save time. If the ignore-warnings flag has been turned on, then
164 these warnings will not be reported. Errors (e.g., invalid log
165 conditions) will always be reported.
166 Delete Selected Rollrecs
168 Delete the selected rollrec records. The buttons for each selected
169 record will be removed from the Button Window.
170 Edit Selected Rollrecs
172 Modify the selected rollrec records. For every record selected
173 for modification, the user is given a new window in which to edit
174 the user-modifiable rollrec fields. When the edit window goes away
175 (after a "Save" or "Cancel"), the rollrec record's button is dese‐
176 lected.
177 After editing is completed, the "Save" button will add the new
179 rollrec record to the in-memory rollrec file. The file must be
180 saved in order to have the new rollrec added to the file.
181 Potentially erroneous conditions will be reported to the user at
183 save time. If the ignore-warnings flag has been turned on, then
184 these warnings will not be reported. Errors (e.g., invalid log
185 conditions) will always be reported.
186 Merge Rollrec Files
188 Merge a rollrec file with the currently open rollrec file. After a
189 successful merge, the rollrec records in the second file will be
190 added to the end of the currently open rollrec file.
191 If there are any rollrec name collisions in the files, then the
193 user will be asked whether to continue with the merge or cancel it.
194 If the merge continues, then the conflicting rollrec records from
195 the "new" file will be discarded in favor of the currently open
196 rollrec file.
197 Verify Rollrec File
199 Verify the validity of the rollrec file. The user-editable fields
200 in the open rollrec file are checked for validity. An edit window
201 is opened for each rollrec record that registers an error or warn‐
202 ing.
203 If the ignore-warnings flag has been turned on, then potentially
205 erroneous conditions will not be reported. Errors (e.g., invalid
206 log conditions) will always be reported.
207 Summarize Problems
209 Summarize the warning and error counts of the rollrec file. Each
210 rollrec record in the open rollrec file is checked for validity.
211 If any warnings or errors are found, a window is displayed that
212 lists the name of each rollrec record and its warning and error
213 counts.
214 If the ignore-warnings flag has been turned on, then potentially
216 erroneous conditions will not be reported. Errors (e.g., invalid
217 log conditions) will always be reported.
218 View Menu
220 The View Menu contains miscellaneous commands for viewing edit windows.
222 Select All Rollrecs/Unselect All Rollrecs
224 Select or unselect all rollrec buttons. All the buttons in the
225 Button Window will be selected or unselected. If any of the but‐
226 tons are not selected, this command will cause all the buttons to
227 become selected. If all of the buttons are selected, this command
228 will cause all the buttons to be deselected.
229 This command is a toggle that switches between Select All Rollrecs
231 and Unselect All Rollrecs.
232 Reveal Rollrec Edit Windows
234 Raise all rollrec edit windows. This command brings all rollrec
235 edit windows to the front so that any that are hidden behind other
236 windows will become visible.
237 Close Rollrec Edit Windows
239 Close all rollrec edit windows. This command closes and deselects
240 all rollrec edit windows.
241 Options Menu
243 The Options Menu allows the user to set several options that control
245 rollrec-editor behavior.
246 Ignore Edit Warnings/Don't Ignore Edit Warnings
248 Certain operations perform validation checks on the contents of
249 rollrec records. Warnings and errors may be reported by these
250 checks. This option controls whether or not warnings are flagged
251 during validation. If they are flagged, then the operation will
252 not continue until the warning condition is fixed or the operation
253 canceled. If the warnings are ignored, then the operation will
254 complete without the condition being fixed.
255 This command is a toggle that switches between Ignore Edit Warnings
257 mode and Don't Ignore Edit Warnings mode.
258 Filter Name Selection/Don't Filter Name Selection
260 When opening rollrec files for editing or merging, a file-selection
261 dialog box is displayed to allow the user to select a rollrec file.
262 This option controls whether a filename filter is used by the dia‐
263 log box. If Filter Names Selection mode is used, then only regular
264 files with a suffix of .rrf will be displayed by the dialog box.
265 If Don't Filter Name Selection mode is used, then all regular files
266 will be displayed by the dialog box.
267 This command is a toggle that switches between Filter Name Selec‐
269 tion display and Don't Filter Name Selection display.
270 Columns in Button Window
272 Set the number of columns used in the Button Window. See the But‐
273 ton Window Layout section for more information on columns in the
274 Button Window.
275 Help Menu
277 The Help Menu contains commands for getting assistance.
279 Help
281 Display a help window.
282
284 Below are the keyboard accelerators for the rollrec-editor commands:
285 Ctrl-A Select All Rollrecs
287 Ctrl-D Delete Selected Rollrecs
289 Ctrl-E Edit Selected Rollrecs
291 Ctrl-H Help
293 Ctrl-K Close Rollrec Edit Windows
295 Ctrl-M Merge Rollrec Files
297 Ctrl-N New Rollrec
299 Ctrl-O Open
301 Ctrl-Q Quit
303 Ctrl-R Reveal Rollrec Edit Windows
305 Ctrl-S Save
307 Ctrl-U Undo Changes (not currently implemented)
309 Ctrl-V Verify Rollrec File
311 These accelerators are all lowercase letters.
313
315 rollrec-editor is implemented in Perl/Tk, so both Perl and Perl/Tk must
316 be installed on your system.
317
319 The following are known issues. These will be resolved in the fullness
320 of time.
321 · There is an issue with the column count and adding new rollrecs.
323 It doesn't always work properly, thus occasionally leaving some
324 rollrec buttons undisplayed.
325 · Segmentation violation on exit. Should not affect anything as file
327 has already been saved. Occurs on MacOS X 10.4.9 with Perl 5.8.6;
328 does not occur on Linux FC5 with Perl 5.8.8.
329 · There is no undo command.
331
333 Copyright 2007 SPARTA, Inc. All rights reserved. See the COPYING file
334 included with the DNSSEC-Tools package for details.
335
337 Wayne Morrison, tewok@users.sourceforge.net
338
340 lsroll(1), rollchk(8), rollerd(8) rollinit(8), rollset(8), zone‐
341 signer(8)
342 Net::DNS::SEC::Tools::rollrec(3)
344 file-rollrec(5)
346perl v5.8.8 2007-09-14 ROLLREC-EDITOR(1)