diff --git a/ChangeLog b/ChangeLog index cc201a2f..da5abc0f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -23102,3 +23102,6 @@ 2022-05-19 Fred Gleason * Updated the 'Managing Podcasts with RDCastManager' chapter of the Operations Guide. +2022-05-19 Fred Gleason + * Updated the 'Configuring Rivendell with RDAdmin' chapter of the + Operations Guide. diff --git a/docs/opsguide/Makefile.am b/docs/opsguide/Makefile.am index 4a876930..3f155106 100644 --- a/docs/opsguide/Makefile.am +++ b/docs/opsguide/Makefile.am @@ -148,7 +148,8 @@ OPSGUIDE_HTML = appendix.filepath_wildcards.html\ sect.wings_filter.usage.html\ sect.voicetracking.using_the_voicetracker_dialog.html -OPSGUIDE_IMAGES = rdadmin.audio_resource_information_dialog.png\ +OPSGUIDE_IMAGES = rdadmin.add_switcher_dialog.png\ + rdadmin.audio_resource_information_dialog.png\ rdadmin.autofill_carts_dialog.png\ rdadmin.configure_rdairplay_dialog.png\ rdadmin.configure_rdcartslots_dialog.png\ diff --git a/docs/opsguide/rdadmin.add_switcher_dialog.png b/docs/opsguide/rdadmin.add_switcher_dialog.png new file mode 100644 index 00000000..11f2195d Binary files /dev/null and b/docs/opsguide/rdadmin.add_switcher_dialog.png differ diff --git a/docs/opsguide/rdadmin.audio_resource_information_dialog.png b/docs/opsguide/rdadmin.audio_resource_information_dialog.png index 0aea40de..03e1d09d 100644 Binary files a/docs/opsguide/rdadmin.audio_resource_information_dialog.png and b/docs/opsguide/rdadmin.audio_resource_information_dialog.png differ diff --git a/docs/opsguide/rdadmin.autofill_carts_dialog.png b/docs/opsguide/rdadmin.autofill_carts_dialog.png index 47a4cc63..980fa46e 100644 Binary files a/docs/opsguide/rdadmin.autofill_carts_dialog.png and b/docs/opsguide/rdadmin.autofill_carts_dialog.png differ diff --git a/docs/opsguide/rdadmin.configure_rdairplay_dialog.png b/docs/opsguide/rdadmin.configure_rdairplay_dialog.png index 4e63634c..817de1cf 100644 Binary files a/docs/opsguide/rdadmin.configure_rdairplay_dialog.png and b/docs/opsguide/rdadmin.configure_rdairplay_dialog.png differ diff --git a/docs/opsguide/rdadmin.configure_rdcartslots_dialog.png b/docs/opsguide/rdadmin.configure_rdcartslots_dialog.png index 9c445fb8..e53d8c13 100644 Binary files a/docs/opsguide/rdadmin.configure_rdcartslots_dialog.png and b/docs/opsguide/rdadmin.configure_rdcartslots_dialog.png differ diff --git a/docs/opsguide/rdadmin.configure_rdcatch_dialog.png b/docs/opsguide/rdadmin.configure_rdcatch_dialog.png index 0adc53df..54b20aa0 100644 Binary files a/docs/opsguide/rdadmin.configure_rdcatch_dialog.png and b/docs/opsguide/rdadmin.configure_rdcatch_dialog.png differ diff --git a/docs/opsguide/rdadmin.configure_rdlibrary_dialog.png b/docs/opsguide/rdadmin.configure_rdlibrary_dialog.png index 11adfa12..41ba3303 100644 Binary files a/docs/opsguide/rdadmin.configure_rdlibrary_dialog.png and b/docs/opsguide/rdadmin.configure_rdlibrary_dialog.png differ diff --git a/docs/opsguide/rdadmin.configure_rdlogedit_dialog.png b/docs/opsguide/rdadmin.configure_rdlogedit_dialog.png index bda76669..96256731 100644 Binary files a/docs/opsguide/rdadmin.configure_rdlogedit_dialog.png and b/docs/opsguide/rdadmin.configure_rdlogedit_dialog.png differ diff --git a/docs/opsguide/rdadmin.configure_rdpanel_dialog.png b/docs/opsguide/rdadmin.configure_rdpanel_dialog.png index 89fb3431..2d3a4ab1 100644 Binary files a/docs/opsguide/rdadmin.configure_rdpanel_dialog.png and b/docs/opsguide/rdadmin.configure_rdpanel_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_audio_ports_dialog.png b/docs/opsguide/rdadmin.edit_audio_ports_dialog.png index 26445ea3..9b21efa3 100644 Binary files a/docs/opsguide/rdadmin.edit_audio_ports_dialog.png and b/docs/opsguide/rdadmin.edit_audio_ports_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_channel_gpios_dialog.png b/docs/opsguide/rdadmin.edit_channel_gpios_dialog.png index 51712b93..c435c040 100644 Binary files a/docs/opsguide/rdadmin.edit_channel_gpios_dialog.png and b/docs/opsguide/rdadmin.edit_channel_gpios_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_gpi_dialog.png b/docs/opsguide/rdadmin.edit_gpi_dialog.png index 94ca401a..3fcb729e 100644 Binary files a/docs/opsguide/rdadmin.edit_gpi_dialog.png and b/docs/opsguide/rdadmin.edit_gpi_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_host_variable_dialog.png b/docs/opsguide/rdadmin.edit_host_variable_dialog.png index b1871f03..b624418e 100644 Binary files a/docs/opsguide/rdadmin.edit_host_variable_dialog.png and b/docs/opsguide/rdadmin.edit_host_variable_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png b/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png index 5351472d..3e2129f5 100644 Binary files a/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png and b/docs/opsguide/rdadmin.edit_pypad_instance_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_serial_ports_dialog.png b/docs/opsguide/rdadmin.edit_serial_ports_dialog.png index 7823b5e4..106d69d1 100644 Binary files a/docs/opsguide/rdadmin.edit_serial_ports_dialog.png and b/docs/opsguide/rdadmin.edit_serial_ports_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_service_dialog.png b/docs/opsguide/rdadmin.edit_service_dialog.png index 6d6a9501..bf2e5046 100644 Binary files a/docs/opsguide/rdadmin.edit_service_dialog.png and b/docs/opsguide/rdadmin.edit_service_dialog.png differ diff --git a/docs/opsguide/rdadmin.edit_switcher_dialog.png b/docs/opsguide/rdadmin.edit_switcher_dialog.png index 51982e88..f41eb826 100644 Binary files a/docs/opsguide/rdadmin.edit_switcher_dialog.png and b/docs/opsguide/rdadmin.edit_switcher_dialog.png differ diff --git a/docs/opsguide/rdadmin.group_dialog.png b/docs/opsguide/rdadmin.group_dialog.png index 54967c9a..bb3cc128 100644 Binary files a/docs/opsguide/rdadmin.group_dialog.png and b/docs/opsguide/rdadmin.group_dialog.png differ diff --git a/docs/opsguide/rdadmin.host_dialog.png b/docs/opsguide/rdadmin.host_dialog.png index 544ca7d3..31d343e8 100644 Binary files a/docs/opsguide/rdadmin.host_dialog.png and b/docs/opsguide/rdadmin.host_dialog.png differ diff --git a/docs/opsguide/rdadmin.host_variables_dialog.png b/docs/opsguide/rdadmin.host_variables_dialog.png index 78d704ae..b879dff5 100644 Binary files a/docs/opsguide/rdadmin.host_variables_dialog.png and b/docs/opsguide/rdadmin.host_variables_dialog.png differ diff --git a/docs/opsguide/rdadmin.hosts_dialog.png b/docs/opsguide/rdadmin.hosts_dialog.png index 4f5b456a..2de02266 100644 Binary files a/docs/opsguide/rdadmin.hosts_dialog.png and b/docs/opsguide/rdadmin.hosts_dialog.png differ diff --git a/docs/opsguide/rdadmin.jack_configuration_dialog.png b/docs/opsguide/rdadmin.jack_configuration_dialog.png index ab9c3525..32f405fa 100644 Binary files a/docs/opsguide/rdadmin.jack_configuration_dialog.png and b/docs/opsguide/rdadmin.jack_configuration_dialog.png differ diff --git a/docs/opsguide/rdadmin.list_gpis_dialog.png b/docs/opsguide/rdadmin.list_gpis_dialog.png index ad61ca16..88ad183a 100644 Binary files a/docs/opsguide/rdadmin.list_gpis_dialog.png and b/docs/opsguide/rdadmin.list_gpis_dialog.png differ diff --git a/docs/opsguide/rdadmin.login_dialog.png b/docs/opsguide/rdadmin.login_dialog.png index 908775c3..21a7f6cc 100644 Binary files a/docs/opsguide/rdadmin.login_dialog.png and b/docs/opsguide/rdadmin.login_dialog.png differ diff --git a/docs/opsguide/rdadmin.pypad_instances_dialog.png b/docs/opsguide/rdadmin.pypad_instances_dialog.png index b1f90818..a872a316 100644 Binary files a/docs/opsguide/rdadmin.pypad_instances_dialog.png and b/docs/opsguide/rdadmin.pypad_instances_dialog.png differ diff --git a/docs/opsguide/rdadmin.rdadmin_screenshot.png b/docs/opsguide/rdadmin.rdadmin_screenshot.png index 0af2a83e..bdd9fce9 100644 Binary files a/docs/opsguide/rdadmin.rdadmin_screenshot.png and b/docs/opsguide/rdadmin.rdadmin_screenshot.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_channel_assignments.png b/docs/opsguide/rdadmin.rdairplay_channel_assignments.png index a7b60a52..747403aa 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_channel_assignments.png and b/docs/opsguide/rdadmin.rdairplay_channel_assignments.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_display_settings.png b/docs/opsguide/rdadmin.rdairplay_display_settings.png index 918e3ed3..130cd931 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_display_settings.png and b/docs/opsguide/rdadmin.rdairplay_display_settings.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_log_mode_control.png b/docs/opsguide/rdadmin.rdairplay_log_mode_control.png index e84f5979..79ea2e31 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_log_mode_control.png and b/docs/opsguide/rdadmin.rdairplay_log_mode_control.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_log_settings.png b/docs/opsguide/rdadmin.rdairplay_log_settings.png index 4436c451..f86b9cfd 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_log_settings.png and b/docs/opsguide/rdadmin.rdairplay_log_settings.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_miscellaneous_settings.png b/docs/opsguide/rdadmin.rdairplay_miscellaneous_settings.png index e826ab42..a210754c 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_miscellaneous_settings.png and b/docs/opsguide/rdadmin.rdairplay_miscellaneous_settings.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_sound_panel_settings.png b/docs/opsguide/rdadmin.rdairplay_sound_panel_settings.png index dc3fe8b8..b6927c3b 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_sound_panel_settings.png and b/docs/opsguide/rdadmin.rdairplay_sound_panel_settings.png differ diff --git a/docs/opsguide/rdadmin.rdairplay_start_stop_settings.png b/docs/opsguide/rdadmin.rdairplay_start_stop_settings.png index 3f115a29..e6aef6a7 100644 Binary files a/docs/opsguide/rdadmin.rdairplay_start_stop_settings.png and b/docs/opsguide/rdadmin.rdairplay_start_stop_settings.png differ diff --git a/docs/opsguide/rdadmin.rename_group_dialog.png b/docs/opsguide/rdadmin.rename_group_dialog.png index b9a52e50..2348d866 100644 Binary files a/docs/opsguide/rdadmin.rename_group_dialog.png and b/docs/opsguide/rdadmin.rename_group_dialog.png differ diff --git a/docs/opsguide/rdadmin.replicator_dialog.png b/docs/opsguide/rdadmin.replicator_dialog.png index 9b0e2dcb..330625c8 100644 Binary files a/docs/opsguide/rdadmin.replicator_dialog.png and b/docs/opsguide/rdadmin.replicator_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_dropbox_configurations_dialog.png b/docs/opsguide/rdadmin.rivendell_dropbox_configurations_dialog.png index 529fb004..446a273e 100644 Binary files a/docs/opsguide/rdadmin.rivendell_dropbox_configurations_dialog.png and b/docs/opsguide/rdadmin.rivendell_dropbox_configurations_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_group_list_dialog.png b/docs/opsguide/rdadmin.rivendell_group_list_dialog.png index ecf2d3a8..06aa6253 100644 Binary files a/docs/opsguide/rdadmin.rivendell_group_list_dialog.png and b/docs/opsguide/rdadmin.rivendell_group_list_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_host_list_dialog.png b/docs/opsguide/rdadmin.rivendell_host_list_dialog.png index fd1ae0eb..cfba3dd7 100644 Binary files a/docs/opsguide/rdadmin.rivendell_host_list_dialog.png and b/docs/opsguide/rdadmin.rivendell_host_list_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_replicators_dialog.png b/docs/opsguide/rdadmin.rivendell_replicators_dialog.png index 9abb5bb0..4cddd4fd 100644 Binary files a/docs/opsguide/rdadmin.rivendell_replicators_dialog.png and b/docs/opsguide/rdadmin.rivendell_replicators_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_scheduler_code_list_dialog.png b/docs/opsguide/rdadmin.rivendell_scheduler_code_list_dialog.png index 7103ce96..910262f4 100644 Binary files a/docs/opsguide/rdadmin.rivendell_scheduler_code_list_dialog.png and b/docs/opsguide/rdadmin.rivendell_scheduler_code_list_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_switcher_list_dialog.png b/docs/opsguide/rdadmin.rivendell_switcher_list_dialog.png index c6b40da9..cb17930c 100644 Binary files a/docs/opsguide/rdadmin.rivendell_switcher_list_dialog.png and b/docs/opsguide/rdadmin.rivendell_switcher_list_dialog.png differ diff --git a/docs/opsguide/rdadmin.rivendell_user_list_dialog.png b/docs/opsguide/rdadmin.rivendell_user_list_dialog.png index 32da5820..42122eb6 100644 Binary files a/docs/opsguide/rdadmin.rivendell_user_list_dialog.png and b/docs/opsguide/rdadmin.rivendell_user_list_dialog.png differ diff --git a/docs/opsguide/rdadmin.scheduler_code_dialog.png b/docs/opsguide/rdadmin.scheduler_code_dialog.png index de88d96a..c4eb76fc 100644 Binary files a/docs/opsguide/rdadmin.scheduler_code_dialog.png and b/docs/opsguide/rdadmin.scheduler_code_dialog.png differ diff --git a/docs/opsguide/rdadmin.select_pypad_script_dialog.png b/docs/opsguide/rdadmin.select_pypad_script_dialog.png index 94bc6ee0..93ab1ddd 100644 Binary files a/docs/opsguide/rdadmin.select_pypad_script_dialog.png and b/docs/opsguide/rdadmin.select_pypad_script_dialog.png differ diff --git a/docs/opsguide/rdadmin.select_scheduler_codes_dialog.png b/docs/opsguide/rdadmin.select_scheduler_codes_dialog.png index 9d3fe3a3..691967e6 100644 Binary files a/docs/opsguide/rdadmin.select_scheduler_codes_dialog.png and b/docs/opsguide/rdadmin.select_scheduler_codes_dialog.png differ diff --git a/docs/opsguide/rdadmin.services_dialog.png b/docs/opsguide/rdadmin.services_dialog.png index 19364f3b..958ff631 100644 Binary files a/docs/opsguide/rdadmin.services_dialog.png and b/docs/opsguide/rdadmin.services_dialog.png differ diff --git a/docs/opsguide/rdadmin.system_wide_settings_dialog.png b/docs/opsguide/rdadmin.system_wide_settings_dialog.png index 2256f800..e29ee7b5 100644 Binary files a/docs/opsguide/rdadmin.system_wide_settings_dialog.png and b/docs/opsguide/rdadmin.system_wide_settings_dialog.png differ diff --git a/docs/opsguide/rdadmin.xml b/docs/opsguide/rdadmin.xml index 03000fd3..952beaa9 100644 --- a/docs/opsguide/rdadmin.xml +++ b/docs/opsguide/rdadmin.xml @@ -10,7 +10,7 @@ - + The RDAdmin Main Window @@ -27,7 +27,7 @@ - + The Login Dialog @@ -45,7 +45,7 @@ - + The Rivendell User List Dialog @@ -55,12 +55,13 @@ Two different types of user exist within Rivendell: administrator users (those which have the - Administer System right set), who + Administer System or + Administer RSS Feeds right set), who are allowed to log into RDAdmin, and operational users, who are configured to have rights to operate specific portions of the Rivendell system but do - not have access to RDAdmin. It is not possible for a single user to - act in both roles. + not have access to RDAdmin. It is not possible + for a single user to act in both roles. A newly created Rivendell database will have one user of each type @@ -101,9 +102,15 @@ The middle section of the dialog is where individual user rights are assigned for this user. The Administer System box, if ticked, - will make this user an administrative user while disallowing the - selection of any other rights. The other listed rights should be - self-explanatory. + will make this user an administrative user, thus permitting login + to RDAdmin, while disallowing the + selection of any other rights; while the + Administer RSS Feeds box, if ticked, + will allow the user to log in to RDAdmin, but only permit access to + the Manage Feeds functionality. + + + The other listed rights should be fairly self-explanatory. The bottom of the dialog contains three large buttons. The @@ -133,7 +140,7 @@ - + The Rivendell Group List Dialog @@ -151,7 +158,7 @@ - + The Rivendell Group Dialog @@ -248,7 +255,7 @@ - + The Rename Group Dialog @@ -275,7 +282,7 @@ - + The Rivendell Services Dialog @@ -291,7 +298,7 @@ - + The Edit Service Dialog @@ -303,7 +310,7 @@ - + The General Section @@ -346,10 +353,6 @@ Inline Event Scheduling Parameters for details. - - - - The Voicetrack Group dropdown specifies the Rivendell group to be used for storing voicetracks @@ -519,7 +522,7 @@ - + The Autofill Carts Dialog @@ -547,7 +550,7 @@ - + The Hosts Dialog @@ -574,7 +577,7 @@ - + Log Importation String Fields @@ -651,7 +654,7 @@ - + The Log Parser Settings @@ -704,7 +707,7 @@ Many schedulers provide an opaque string with each scheduling record which they expect to be returned as part of the corresponding Electronic - Log Reconciliation (ELR) feed back to the system. This field + Log Reconciliation (ELR) fed back to the system. This field indicates where this "GUID" string should be found. @@ -734,7 +737,7 @@ - + The Test Import Dialog @@ -761,7 +764,7 @@ - + The Rivendell Host List Dialog @@ -777,7 +780,7 @@ - + The Host Dialog @@ -838,6 +841,32 @@ xterm1 window --i.e. xterm -e vi. + + The Web Browser: is used to + specify an external web browser to be used to display HTML content. + If desired, the value should consist of the command invocation + needed to start the browser. + + + The SSH Ident. File: field contains + the path to the SSH identity (private key) file used to + authenticate SFTP file transfers when the + Authenticate with local identity file + box is ticked in an RSS feed's configuration dialog. See the + ssh-keygen1 man page for + information on generating SSH identity key pair files. + + + The SSH identity file must be owned by the same user specified by the + AudioOwner parameter in the + [Identity] section of the + rd.conf5 configuration + file and have permission mode 0600, + otherwise transfers with fail with an + Authentication Failed error. + See the rd.conf5 man + page for more information. + The Time Offset: field can be used to specify a static time offset in milliseconds to by applied to @@ -906,7 +935,7 @@ - + The Configure RDLibrary Dialog @@ -958,7 +987,8 @@ For further information on the Low and None options, see the - '-Y' and '-Z' options in the cdparanoia(1) man page or + '-Y' and '-Z' options in the + cdparanoia1 man page or https://linux.die.net/man/1/cdparanoia. @@ -967,14 +997,65 @@ Standard Recording Code data from audio tracks when loading the disc. Setting this to Yes can cause CD-ROM drives - to take signficantly longer to read the table of contents of + to take significantly longer to + read the table of contents of newly inserted discs when the disc does not contain ISRC data. - The FreeDB Server: field takes the - URL of the server to be used for doing FreeDB lookups for CDs by - the CD ripper. + The CD Metadata Source: dropdown + determines the type of data source that will be used to lookup + CDs for metadata records. Three options are available: + + + MusicBrainz + + + Use a + MusicBrainz database. + This is the default. + + + If selected, the + MusicBrainz Server: field is + used to provide the hostname of the server. Default value is + musicbrainz.org, a public server + provided by the + MetaBrainz + Foundation (but kindly see the note regarding + commercial use at + https://metabrainz.org/supporters/account-type). + + + + + FreeDB + + + Use a + FreeDB database. + + + If selected, the FreeDB Server: + field is used to provide the hostname of the server. + + + Since the original public FreeDB gateway at + freedb.freedb.org was + shutdown in March 2019, use of a FreeDB database will + generally require that a site maintain their own database server. + + + + + None + + + Do not perform any metadata lookup. + + + + The Format: dropdown indicates the audio encoding format to be used in Rivendell's audio store for @@ -1011,7 +1092,7 @@ dropdowns in rdlibrary(1). - TheRecord Mode and + The Record Mode and AutoTrim dropdowns set the default value of the respective dropdowns in the Record dialog. @@ -1032,7 +1113,7 @@ - + The Configure RDCatch Dialog @@ -1068,16 +1149,21 @@ The Switcher Host:, Switcher Matrix: and - Switcher Output: controls can + Switcher Output: dropdowns can be used to configure a switcher device for routing multiple audio - signals into this record deck. The specified switcher output - should be connected to the input specified by the + signals into this record deck on a per-event basis. The specified + switcher output should be connected to the input specified by the Card: and Port: controls. + + See + + for more information on configuring switcher devices. + The Channels: control sets - the default value of the same control in rdcatch(1), while the + the default value of the same control in RDCatch, while the Trim Threshold sets the default value of the autotrim Level: control. @@ -1095,17 +1181,19 @@ audio output will be used by the deck. - The Event Cart take the number of + The Event Carts fields take the + number of the macro cart that will be executed each time the corresponding - event marker (originally placed during recording by the Cut Event - ['CE'] RML) is encountered during playback. + event marker, originally placed during recording by the Cut Event + ['CE'] RML is encountered during playback. See + for more information. Host-Wide Settings The Error RML: field takes RML - code that will be executed whenever rdcatch(1) encounters an error + code that will be executed whenever RDCatch encounters an error in operations --e.g. a file download failure. @@ -1120,7 +1208,7 @@ - + The Configure RDAirPlay Dialog @@ -1137,7 +1225,7 @@ - + Channel Assignments Section @@ -1145,14 +1233,14 @@ - Audio outputs for the Main Log, both Aux Logs and the Sound Panel - are configured by means of the + Audio outputs for the Main Log, both Aux Logs, Virtual Logs and + the Sound Panel are configured by means of the Card: and Port: controls. For the Main Log, if both Output 1 and Output 2 are set to different - card and/or port values, rdairplay(1)'s output will alternate + card and/or port values, RDAirPlay's output will alternate between the two outputs. @@ -1172,7 +1260,7 @@ - + Edit Channel GPIOs Dialog @@ -1190,6 +1278,11 @@ output event emitted by Rivendell each time the corresponding channel is started or stopped (typically mapped to the fader ON or OFF remote control on the associated mixer desk). + + See + + for more information on configuring GPIO devices. + @@ -1202,7 +1295,7 @@ - + Start/Stop Section @@ -1215,7 +1308,7 @@ rdairplay(1) (useful for preventing inadvertent shutdowns). - For each of the log machines (Main Log, Aux 1 Log and Aux 2 Log), + For each of the selected log machines it is possible to specify the action to take at startup by selecting the appropriate value in the At Startup: dropdown. If the @@ -1235,7 +1328,7 @@ - + Display Settings @@ -1244,28 +1337,35 @@ The Background Image: field takes - the full path to a bitmap file to use as the background - "skin" for rdairplay(1)'s main window. The file should - be 1024x738 resolution and be of type JPG or PNG. + the full path to an image file to use as the background + "skin" for RDAirPlay's main window. The file should + be of type JPG or PNG. + + + The Logo Image: field takes the + full pathname to an image file to display in the upper right-hand + corner of RDAirPlay. The image should should have dimensions of + 167x125 pixels and be of type JPG or PNG. Each of the Template: fields define the formatting of one of the lines of the label areas in the - button widget. - Metadata wildcards are used to define the contents to be - displayed. + button widget. Metadata wildcards are used to define the contents + to be displayed. See + for a list of supported wildcards. + Log Mode Control The Log Mode Control section - configures the behavior of rdairplay(1) mode controls. + configures the behavior of RDAirPlay mode controls. - + Log Mode Control @@ -1293,7 +1393,7 @@ - + Log Settings @@ -1339,7 +1439,7 @@ - + Sound Panel Settings @@ -1347,7 +1447,7 @@ - The total number of system and User panels are set with the + The total number of System and User panels are set with the System Panels: and User Panels: fields respectively. @@ -1366,7 +1466,9 @@ The Label Template control determines the default button legend for newly created Sound Panel buttons. - Metadata wildcards can be used in this field. + Metadata wildcards can be used in this field. See + for a list of supported + wildcards. @@ -1374,7 +1476,7 @@ - + Miscellaneous Settings @@ -1420,62 +1522,22 @@ before the current play position an audition playout will begin. - The Space Bar Action sets what - action will taken when the space bar is pressed. + The Space Bar Action dropdown + sets what action will taken when the space bar is pressed. - - Configuring Hotkeys - - Keyboard shortcuts (also known as "hotkeys") can be - configured by touch the - Configure Hotkeys button, bringing - up the Hot Key Configuration dialog. - - - - - - - - The Hotkey Configuration Dialog - - - - - A hotkey can be assigned to a particular function by selecting - that function off of the - Host Hot Key Configuration list, - pressing and releasing the desired key, and then touching the - Set button. To remove a hotkey - assignment, select the desired function and then touch the - Clear button. Touching the - Clear All Hotkeys button will - clear all hotkey assignments for this host. - Hotkey assignments from a different host can be copied to this - one by selecting the desired source host in the - Set From Host: dropdown and - then touching Save. - - - - Not all keys may be mappable as a hotkey, as certain window - managers "steal" keys for their own use! - - - Configuring RDPanel - To configure the rdpanel(1) module, touch the + To configure the RDPanel module, touch the RDPanel button to open the Configure RDPanel dialog. - + The Configure RDPanel Dialog @@ -1483,16 +1545,16 @@ - The rdpanel(1) application is merely a larger version of - the Sound Panel portion of rdairplay(1). As such, its configuration - closely mirrors that of the - - RDAirPlay configuration. Please see that section for details. + The RDPanel application is merely a larger version of + the Sound Panel portion of RDAirPlay. As such, its configuration + is very similar to that of the Sound Panel section in + . + Please see that section for details. - Although rdpanel(1)'s panels appear similar to rdairplay(1)'s panels, - rdpanel(1) has its own set of system and user panels that are independent - of rdairplay(1) and must be set up separately. + Although RDPanel's panels appear similar to RDAirPlay's panels, + RDPanel has its own set of system and user panels that are independent + of RDAirPlay and must be set up separately. @@ -1505,7 +1567,7 @@ - + The Configure RDLogEdit Dialog @@ -1513,10 +1575,15 @@ - The INPUT and - OUTPUT are used to specify - the audio input and output to be used. + The Input and + Output controls are used to specify + the audio input and output to be used for the interactive + voicetracker. + + These channel assignments are also used for the voicetracker when + it is being accessed through the RDAirPlay module! + The Max Record Time field sets the maximum time that rdlogedit(1)'s voice tracker will run in @@ -1534,6 +1601,11 @@ audio level at which to peak normalize the recorded audio in the voice tracker. + + The Audio Margin control sets + how much of the end of the first track in the voicetracker will + be visible by default when a new transition is loaded. + The Format: and Bit Rate: dropdowns are used @@ -1581,7 +1653,7 @@ - + The Configure RDCartSlots Dialog @@ -1648,7 +1720,7 @@ - + The Rivendell Dropbox Configurations Dialog @@ -2001,7 +2073,7 @@ - + The Select Scheduler Codes Dialog @@ -2020,7 +2092,7 @@ - + The Rivendell Switcher List Dialog @@ -2029,13 +2101,29 @@ To add a new Switcher/GPIO device, touch the - Add button to open the Edit Switcher + Add button to open the Add Switcher dialog. - + + + + The Add Switcher Dialog + + + + + Select the type of switcher being added on the + Switcher Type: dropdown and then + touch the Add button to open the + Edit Switcher dialog. + + + + + The Edit Switcher Dialog @@ -2049,7 +2137,7 @@ requirements. The description which follows provides a broad overview of how these devices are configured, but be sure to consult the device-specific notes for the unit question in - as well!. + as well. @@ -2119,7 +2207,7 @@ The Configure Inputs and Configure Outputs buttons can be used to assign names to each switcher input and output - on the target device. These names will appear in rdcatch(1) when + on the target device. These names will appear in RDCatch when configuring record events. @@ -2132,7 +2220,7 @@ - + The List GPIs Dialog @@ -2147,7 +2235,7 @@ - + The Edit GPI Dialog @@ -2193,7 +2281,7 @@ - + The Host Variables Dialog @@ -2209,7 +2297,7 @@ - + The Edit Host Variable Dialog @@ -2228,7 +2316,7 @@ - + The Edit Audio Ports Dialog @@ -2289,7 +2377,7 @@ - + The Edit Serial Ports Dialog @@ -2314,7 +2402,7 @@ - + The Audio Resource Information Dialog @@ -2330,12 +2418,6 @@ More information can be found at http://jackaudio.org. - - Rivendell's JACK connectivity is handed by the caed(8) daemon, - and so both jackd(1) and caed(8) must operate under the same - Linux user in order to be able to communicate. Under stock - Rivendell, caed(8) is run as user 'root' [UID 0]. - To configure Rivendell's integration with JACK, touch the JACK Settings button to bring @@ -2344,7 +2426,7 @@ - + The JACK Configuration Dialog @@ -2369,7 +2451,8 @@ Filepath wildcards can used in the command-line field. The clients will be run under the same user as that of the - caed(8) daemon (user 'root' [UID 0] with sstock Rivendell). + caed8 daemon + (user 'root' [UID 0] with stock Rivendell). Port connections between JACK clients can be managed by use of the Jack Connect ['JC'] and Jack Disconnect ['JD'] RMLs. See and @@ -2381,8 +2464,7 @@ PyPAD is a system that is built into Rivendell that allows processing and transmission of Program Associated Data [PAD] - by means of scripts written in the popular Python programming - language. + by means of scripts written in the Python programming language. See for information @@ -2397,7 +2479,7 @@ - + The PyPAD Instances Dialog @@ -2412,7 +2494,7 @@ - + The Select PyPAD Script Dialog @@ -2427,7 +2509,7 @@ - + The Select PyPAD Script Dialog @@ -2449,7 +2531,7 @@ have been applied to the active instance. - It is not necessary to restart rdairplay(1) for the configuration + It is not necessary to restart RDAirPlay for the configuration changes to be made effective. @@ -2519,13 +2601,18 @@ - + The System-Wide Settings Dialog + + The Realm Name: field takes a string + that identifies the complete set of Rivendell hosts that share a + common database. It should be globally unique. + The System Sample Rate: dropdown sets the global sample rate to be used for Rivendell's audio store. This @@ -2563,51 +2650,53 @@ The ISCI Cross Reference Path: field takes the full path to the ISCI cross reference file used by the - rdrepld(8) daemon (used only in conjunction with X-Digital copysplit - replication). + rdrepld8 daemon (used only + in conjunction with X-Digital copy-split replication). The Origin E-Mail Address: field - take the value that Rivendell will use as the "From:" address + takes the value that Rivendell will use as the "From:" address when sending e-mail. - + Rivendell uses the system's sendmail1 interface when originating e-mail. For many modern e-mail setups, additional site- - and distro-specific configuration will likely be necessary beyond - what can be covered here. - + and distro-specific configuration will be necessary to produce + a working outbound e-mail setup beyond what can be covered here. + The Multicast Address for Notifications: field takes the IPv4 multicast address to use for communicating state and configuration changes between Rivendell hosts and modules. It should seldom be necessary to change this value from the default - (239.19.255.72). + (239.19.255.72) unless unless Rivendell hosts + from two or more different Rivendell realms will be sharing a common + multicast domain. In such cases, each realm should have its own unique + multicast address. The Maximum Remote Post Length: field sets the maximum length POST submission that will be processed by the - RDXport service. It should seldom be necessary to change this value. + RDXport service. The Temporary Cart Group: dropdown sets the Rivendell group to be used for storing temporary carts --e.g. carts used for processing direct file play-outs in - rdcartslots(1). + RDCartSlots. The Process RSS Updates On: dropdown sets the Rivendell host to be used for processing automatic state changes for RSS feeds. If no RSS feeds are configured, this value - can be set to [none]. + can safely be set to [none]. - Touching the Edit Encoder List button - will bring up the Encoder Profiles - dialog. See - - for more information. + The Date/Time Formats settings can + be used to customize the display formats for various date/time elements. + For a list of the wildcards used in the formatting strings, see + . @@ -2638,7 +2727,7 @@ - + The Rivendell Scheduler Codes List Dialog @@ -2653,7 +2742,7 @@ - + The Scheduler Code Dialog @@ -2665,10 +2754,10 @@ Managing Replicators A replicator is a Rivendell service that provides - the ability to move content automatically to different system on the - basis of predefined rules. At present, Rivendell includes one such - replicator, which can move audio material to an X-Digital satelite - head-end system. + the ability to move content automatically between different system + realms on the basis of predefined rules. At present, Rivendell includes + one such replicator, which can move audio material to an X-Digital + satellite head-end system. To manage replicators, touch the @@ -2678,7 +2767,7 @@ - + The Rivendell Replicators Dialog @@ -2692,7 +2781,7 @@ - + The Replicator Dialog