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
26 modification 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
32 COMMANDS 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
42 directories associated with a zone actually exist. This check may be
43 turned off at command start-up with the -ignore-warns command line
44 option. It may be modified during execution with the "Ignore Edit
45 Warnings" menu command.
46 Button Window Layout
48 The Button Window contains a button for each rollrec record in the
49 selected file. The buttons are arranged in a table that with at least
50 three columns. The number of columns may be set at command start-up
51 with the -columns command line option. It may be modified during
52 execution with the "Columns in Button Window" menu command.
53 When setting the number of columns, rollrec-editor minimizes the space
55 required to display the selected file's rollrec buttons. This will
56 sometimes cause the number of columns to differ from that requested.
57 For example, assume a rollrec file has 12 rollrec records. The
59 following table shows how many rows and columns are given for each of
60 the given column selections.
61 column count rows columns
63 1 12 1
64 2 6 2
65 3 4 3
66 4 3 4
67 5 3 4
68 6 2 6
69 7 2 6
70 8 2 6
71 9 2 6
72 10 2 6
73 11 2 6
74 12 1 12
75 The actual rows and columns for a requested column count will vary in
77 order to allow a "best-fit".
78 UNDOING MODIFICATIONS
80 The "undo" capability is not currently implemented.
81 rollrec-editor has the ability to reverse modifications it has made to
83 a rollrec file. This historical restoration will only work for
84 modifications made during a particular execution of rollrec-editor;
85 modifications made during a previous execution may not be undone.
86 After a "Save" operation, the data required for reversing modifications
88 are deleted. This is not the case for the "Save As" operation.
89
91 rollrec-editor supports the following options.
92 -columns columns
94 This option allows the user to specify the number of columns to be
95 used in the Button Window.
96 -ignore-warns
98 This option causes rollrec-editor to ignore edit warnings when
99 performing validation checks on the contents of rollrec records.
100 -no-filter
102 This option turns off name filtering when rollrec-editor presents a
103 file-selection dialog for choosing a new rollrec file. If this
104 option is not given, then the file-selection dialog will only list
105 regular files with a suffix of .rrf.
106 -Version
108 Displays the version information for rollrec-editor and the DNSSEC-
109 Tools package.
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
117 stopping execution.
118 Open
120 Open a new rollrec file. If the specified file does not exist, the
121 user will be prompted for the action to take. If the user chooses
122 the "Continue" action, then rollrec-editor will continue editing
123 the current rollrec file. If the "Quit" action is selected, then
124 rollrec-editor will exit.
125 Save
127 Save the current rollrec file. The data for the "Undo Changes"
128 command are purged, so this file will appear to be unmodified.
129 Nothing will happen if no changes have been made.
131 Save As
133 Save the current rollrec file to a name selected by the user.
134 Quit
136 Exit rollrec-editor.
137 Edit Menu
139 The Edit Menu contains commands for general editing operations.
140 Undo Changes
142 Reverse modifications made to the rollrec records. This is only
143 for the in-memory version of the rollrec file.
144 Not currently implemented.
146 Commands Menu
148 The Commands Menu contains commands for modifying rollrec records.
149 New Rollrec
151 Create a new rollrec record. The user is given a new window in
152 which to edit the user-modifiable rollrec fields. A button for the
153 new rollrec record will be inserted into the Button Window.
154 After editing is completed, the "Save" button will add the new
156 rollrec record to the in-memory rollrec file. The file must be
157 saved in order to have the new rollrec added to the file.
158 Potentially erroneous conditions will be reported to the user at
160 save time. If the ignore-warnings flag has been turned on, then
161 these warnings will not be reported. Errors (e.g., invalid log
162 conditions) will always be reported.
163 Delete Selected Rollrecs
165 Delete the selected rollrec records. The buttons for each selected
166 record will be removed from the Button Window.
167 Edit Selected Rollrecs
169 Modify the selected rollrec records. For every record selected
170 for modification, the user is given a new window in which to edit
171 the user-modifiable rollrec fields. When the edit window goes away
172 (after a "Save" or "Cancel"), the rollrec record's button is
173 deselected.
174 After editing is completed, the "Save" button will add the new
176 rollrec record to the in-memory rollrec file. The file must be
177 saved in order to have the new rollrec added to the file.
178 Potentially erroneous conditions will be reported to the user at
180 save time. If the ignore-warnings flag has been turned on, then
181 these warnings will not be reported. Errors (e.g., invalid log
182 conditions) will always be reported.
183 Rename Selected Rollrec
185 Rename the selected rollrec record. The name in the rollrec's
186 "roll" or "skip" line will be changed to the new name. Only one
187 rollrec may be renamed at a time, and it may not be edited while
188 the rename is taking place.
189 If the rollrec has been modified, the new contents must be written
191 to disk prior to the rename happening. The user will be prompted
192 to ensure that this the user wishes to continue.
193 Merge Rollrec Files
195 Merge a rollrec file with the currently open rollrec file. After a
196 successful merge, the rollrec records in the second file will be
197 added to the end of the currently open rollrec file.
198 If there are any rollrec name collisions in the files, then the
200 user will be asked whether to continue with the merge or cancel it.
201 If the merge continues, then the conflicting rollrec records from
202 the "new" file will be discarded in favor of the currently open
203 rollrec file.
204 Verify Rollrec File
206 Verify the validity of the rollrec file. The user-editable fields
207 in the open rollrec file are checked for validity. An edit window
208 is opened for each rollrec record that registers an error or
209 warning.
210 If the ignore-warnings flag has been turned on, then potentially
212 erroneous conditions will not be reported. Errors (e.g., invalid
213 log conditions) will always be reported.
214 Summarize Problems
216 Summarize the warning and error counts of the rollrec file. Each
217 rollrec record in the open rollrec file is checked for validity.
218 If any warnings or errors are found, a window is displayed that
219 lists the name of each rollrec record and its warning and error
220 counts.
221 If the ignore-warnings flag has been turned on, then potentially
223 erroneous conditions will not be reported. Errors (e.g., invalid
224 log conditions) will always be reported.
225 View Menu
227 The View Menu contains miscellaneous commands for viewing edit windows.
228 Select All Rollrecs/Unselect All Rollrecs
230 Select or unselect all rollrec buttons. All the buttons in the
231 Button Window will be selected or unselected. If any of the
232 buttons are not selected, this command will cause all the buttons
233 to become selected. If all of the buttons are selected, this
234 command will cause all the buttons to be deselected.
235 This command is a toggle that switches between Select All Rollrecs
237 and Unselect All Rollrecs.
238 Reveal Rollrec Edit Windows
240 Raise all rollrec edit windows. This command brings all rollrec
241 edit windows to the front so that any that are hidden behind other
242 windows will become visible.
243 Close Rollrec Edit Windows
245 Close all rollrec edit windows. This command closes and deselects
246 all rollrec edit windows.
247 Options Menu
249 The Options Menu allows the user to set several options that control
250 rollrec-editor behavior.
251 Ignore Edit Warnings/Don't Ignore Edit Warnings
253 Certain operations perform validation checks on the contents of
254 rollrec records. Warnings and errors may be reported by these
255 checks. This option controls whether or not warnings are flagged
256 during validation. If they are flagged, then the operation will
257 not continue until the warning condition is fixed or the operation
258 canceled. If the warnings are ignored, then the operation will
259 complete without the condition being fixed.
260 This command is a toggle that switches between Ignore Edit Warnings
262 mode and Don't Ignore Edit Warnings mode.
263 Filter Name Selection/Don't Filter Name Selection
265 When opening rollrec files for editing or merging, a file-selection
266 dialog box is displayed to allow the user to select a rollrec file.
267 This option controls whether a filename filter is used by the
268 dialog box. If Filter Names Selection mode is used, then only
269 regular files with a suffix of .rrf will be displayed by the dialog
270 box. If Don't Filter Name Selection mode is used, then all regular
271 files will be displayed by the dialog box.
272 This command is a toggle that switches between Filter Name
274 Selection display and Don't Filter Name Selection display.
275 Columns in Button Window
277 Set the number of columns used in the Button Window. See the
278 Button Window Layout section for more information on columns in the
279 Button Window.
280 Help Menu
282 The Help Menu contains commands for getting assistance.
283 Help
285 Display a help window.
286
288 Below are the keyboard accelerators for the rollrec-editor commands:
289 Ctrl-A Select All Rollrecs
291 Ctrl-D Delete Selected Rollrecs
293 Ctrl-E Edit Selected Rollrecs
295 Ctrl-H Help
297 Ctrl-K Close Rollrec Edit Windows
299 Ctrl-M Merge Rollrec Files
301 Ctrl-N New Rollrec
303 Ctrl-O Open
305 Ctrl-Q Quit
307 Ctrl-R Reveal Rollrec Edit Windows
309 Ctrl-S Save
311 Ctrl-U Undo Changes (not currently implemented)
313 Ctrl-V Verify Rollrec File
315 These accelerators are all lowercase letters.
317
319 rollrec-editor is implemented in Perl/Tk, so both Perl and Perl/Tk must
320 be installed on your system.
321
323 The following are known issues. These will be resolved in the fullness
324 of time.
325 • There is an issue with the column count and adding new rollrecs.
327 It doesn't always work properly, thus occasionally leaving some
328 rollrec buttons undisplayed.
329 • There is no undo command.
331
333 Copyright 2007-2014 SPARTA, Inc. All rights reserved. See the COPYING
334 file included with the DNSSEC-Tools package for details.
335
337 Wayne Morrison, tewok@tislabs.com
338
340 lsroll(1), rollchk(8), rollerd(8) rollinit(8), rollset(8),
341 zonesigner(8)
342 Net::DNS::SEC::Tools::rollrec(3)
344 file-rollrec(5)
346perl v5.34.0 2022-01-20 ROLLREC-EDITOR(1)