diff --git a/.gitignore b/.gitignore index c1b10df4..0c11970e 100644 --- a/.gitignore +++ b/.gitignore @@ -32,12 +32,9 @@ configure depcomp docs/apis/*.html docs/apis/*.pdf +docs/opsguide/frontspiece.xml docs/opsguide/*.html docs/opsguide/*.pdf -docs/opsguide/frontspiece.xml -docs/stylesheets/book-common.xml -docs/stylesheets/book-fo.xml -docs/stylesheets/book-xhtml.xml helpers/cwrap helpers/jsmin importers/nexgen_filter diff --git a/ChangeLog b/ChangeLog index 66a71f6d..03a5f872 100644 --- a/ChangeLog +++ b/ChangeLog @@ -16259,3 +16259,5 @@ 'Supported GPIO/Switcher Devices' appendix in the Operations Guide. 2017-11-06 Fred Gleason * Added a logo to the title page of the Operations Guide. +2017-11-06 Fred Gleason + * Added the Operations Guide to 'rivendell.spec.in'. diff --git a/configure.ac b/configure.ac index 2c239ae9..1d4fb91d 100644 --- a/configure.ac +++ b/configure.ac @@ -242,7 +242,11 @@ if test -z $DOCBOOK_DISABLED ; then USING_DOCBOOK=yes fi AM_CONDITIONAL([DOCBOOK_AM], [test "$USING_DOCBOOK" = yes]) -AC_SUBST(DOCBOOK_STYLESHEETS,$DOCBOOK_STYLESHEETS) +if test $DOCBOOK_STYLESHEETS ; then + ln -s $DOCBOOK_STYLESHEETS helpers/docbook +fi + +#AC_SUBST(DOCBOOK_STYLESHEETS,$DOCBOOK_STYLESHEETS) # # RDXport Debug @@ -507,9 +511,6 @@ AC_CONFIG_FILES([rivendell.spec \ docs/manpages/Makefile \ docs/opsguide/frontspiece.xml \ docs/opsguide/Makefile \ - docs/stylesheets/book-common.xml \ - docs/stylesheets/book-fo.xml \ - docs/stylesheets/book-xhtml.xml \ docs/stylesheets/Makefile \ docs/tables/Makefile \ debian/Makefile \ diff --git a/docs/apis/Makefile.am b/docs/apis/Makefile.am index fba067c8..dda351e0 100644 --- a/docs/apis/Makefile.am +++ b/docs/apis/Makefile.am @@ -33,17 +33,12 @@ all-local: cae.html\ cae.pdf\ - rml.html\ - rml.pdf\ web_api.html\ web_api.pdf EXTRA_DIST = cae.html\ cae.pdf\ cae.xml\ - rml.html\ - rml.pdf\ - rml.xml\ web_api.html\ web_api.pdf\ web_api.xml diff --git a/docs/apis/rml.xml b/docs/apis/rml.xml deleted file mode 100644 index 0655694a..00000000 --- a/docs/apis/rml.xml +++ /dev/null @@ -1,2296 +0,0 @@ - -
- - Rivendell Macro Language - 1.0.0 - - - Fred - Gleason - fredg@paravelsystems.com - - - - - - Scope - - Rivendell Macro Language (RML) is a system of commands formulated to - specify actions to be taken by and within the Rivendell Radio Automation - system. - - - - - Protocol - - The Normal form of a command takes the following syntax: - - - cmd [arg] [...]! - - - - - cmd - - - - A command mneumonic consisting of two alpha-numeric characters - indicating the action to be performed. - - - - - - arg - - - - Zero or more arguments, delimited by spaces or, if the last - argument, by ! (see below) - - - - - - ! - - - - The ASCII character 33, indicating the end of the command sequence. - - - - - - - - Command Delivery - - To be executed by a Rivendell system, an appropriate command should be - delivered to UDP ports 5858 or 5859 on said system, using the SOCK_DGRAM - connectionless protocol. Commands delivered to port 5858 may receive a - reply back to the originating IP address at UDP socket 5860 to indicated - command success/failure, while commanders delivered to 5859 will be - processed, but no reply made. - - - - - Command Reply - - If delivered to UDP port 5858, each command may receive a reply, - formulated as follows: - - - rpy +|- - - - - - rpy - - - - The full command string (including arguments) originally received - - - - - - + - - - - ACK response, indicates success of the command. - - - - - - - - - - - NAK response, indicates failure of the command. - - - - - - - - Specifying Color - - In places where a color can be specified as a macro argument, the - following predefined values are valid: - - - white - red - green - blue - cyan - magenta - yellow - gray - lightGray - black - darkRed - darkGreen - darkBlue - darkCyan - darkMagenta - darkYellow - darkGray - - - - - Binary Data - - Certain commands (e.g. SO and UO) - have the ability to transmit arbitrary binary data in addition to textual - characters. Such arbitrary binary data can be specified by means of - escape codes as follows: - - - %hexcode - - - - - - hexcode - - - Two digit numeric value of the byte to send in hexidecimal. - - - - - - For example, the sequence 'TEST' followed by a carriage return/newline - could be specified as: - - - TEST%0D%0A - - - - - Commands - - <command>Air Gate [AG]</command> - - - - Module - ripcd8 - - - Mnemonic - AG - - - - - Process an RML only if the On-Air flag is ON. - - - AG - rml! - - - Execute RML rml only if the On-Air flag on - the local machine is ON. - - - - - <command>Add Next [PX]</command> - - - - Module - rdairplay1 - - - Mnemonic - PX - - - - - Insert a cart in a log in the next to play position. - - - PX - mach - cart! - - - Insert cart cart> in the next to play - position on log machine mach. - - - - - <command>Binary Serial Out [BO]</command> - - - - Module - ripcd8 - - - Mnemonic - BO - - - - - Output a string of binary codes. - - - BO - portnum - hexcode - ..! - - - Output a string of binary codes represented by - hexcode .. on - serial port portnum! - - - - - <command>Clear Serial Trap [SC]</command> - - - - Module - ripcd8 - - - Mnemonic - SC - - - - - Clear a serial trap. - - - SC - portnum - cart - string! - - - SC - portnum - cart! - - - SC - portnum! - - - Clear a serial trap. The three argument form will clear all traps on - port that reference - cart and string. - The two argument form will clear all traps on - port that reference - cart, while the one argument form will - clear all traps on port. - - - - - <command>Command Send [CC]</command> - - - - Module - ripcd8 - - - Mnemonic - CC - - - - - Send RML to a remote host. - - - CC - dest - [:udpport] - rml! - - - Send the RML command rml to - dest.dest may be - either a Rivendell host name or an IP address. A UDP port value may be - optionally specified as udpport (default - value 5859). - - - - - <command>Connect Jack Ports [JC]</command> - - - - Module - ripcd8 - - - Mnemonic - JC - - - - - Connect a JACK input port to an output port. - - - JC - output - input! - - - Attempt to connect JACK input port input - to output. - - - - - <command>Console Label [CL]</command> - - - - Module - ripcd8 - - - Mnemonic - CL - - - - - Set the label on a control surface. - - - CL - matrix - surface - chan - label! - - - On matrix matrix, set the input - chan module label of control surface - surface to label. - - - - - <command>Copy Cut [CP]</command> - - - - Module - rdcatchd8 - - - Mnemonic - CP - - - - - Copy cut audio and metadata. - - - CP - srccart - srccut - dstcart - dstcut! - - - Copy the audio and metadata from cut number - srccut in cart - srccart to cut number - dstcut in cart - dstcart. The destination cart/cut must - already exist. - - - - - <command>Cut Event [CE]</command> - - - - Module - rdcatchd8 - - - Mnemonic - CE - - - - - Place a cut event at the current location of an active RDCatch recording. - - - CE - decknum - eventnum! - - - Place a cut event with event number - eventnum at the current position of the - active recording in RDCatch Deck - decknum. - - - - - <command>Database Backup [DB]</command> - - - - Module - ripcd8 - - - Mnemonic - DB - - - - - Backup the Rivendell database. - - - DB - filename! - - - Create a backup copy of the active Rivendell database in - filename. - - - - - <command>Disconnect Jack Ports [JD]</command> - - - - Module - ripcd8 - - - Mnemonic - JD - - - - - Disconnect a JACK input port from an output port. - - - JD - output - input! - - - Attempt to disconnect JACK input port input - from output. - - - - - <command>Duck Panel Button [PD]</command> - - - - Module - rdairplay1 - - - Mnemonic - PD - - - - - Set the duck level of a SoundPanel button in RDAirPlay. - - - PD - panel - col - row - level - fade - [mport]! - - - Set the duck level of button at column, - row> of panel - panel. - Panel: S1...S50 or - U1...U50; - C for panel means - currently selected panel. - If col and/or row - is 0: duck all buttons in - col or row. - If playing, the audio fades to level - (in dbFS) in fade msecs. - If specified, only stop carts playing on panel port - mport. The duck level will be set to 0 after - the playback is finished, or the button is stopped or reset. - - - - - <command>Execute Breakaway [DX]</command> - - - - Module - rdcartslots1 - - - Mnemonic - DX - - - - - Execute a breakaway. - - - DX - slotlen! - - - Execute a breakaway of length len (in mS) - using the autofill carts configured for the service currently loaded - in the slot slot. The slot must be in - Breakaway mode. If a breakaway is currently executing, it will - immediately be aborted and a new one started. Passing a '0' for - len will cause any currently executing - breakaway immediately to be aborted and input audio restored. - - - - - <command>Execute Cart [EX]</command> - - - - Module - rdcatchd8 - - - Mnemonic - EX - - - - - Execute a macro cart. - - - EX - cartnum! - - - Execute macro cart cartnum on the local host. - - - - - <command>Fire Salvo [FS]</command> - - - - Module - ripcd8 - - - Mnemonic - FS - - - - - Execute a switcher salvo. - - - FS - matrix - salvo! - - - Fire salvo number salvo on matrix - matrix. - - - - - <command>GPI Enable [GE]</command> - - - - Module - ripcd8 - - - Mnemonic - GE - - - - - Enable/disable a GPI line. - - - GE - matrix - type - gpinum - state! - - - Enable or disable the GPI line of type type - indicated by gpinum on matrix - matrix. Possible types are: - - - - - I - Input - - - O - Output - - - - - - - <command>GPI Enable [GE]</command> (old format, deprecated) - - - - Module - ripcd8 - - - Mnemonic - GE - - - - - Enable/disable a GPI line. - - - GE - matrix - gpinum - state! - - - Enable or disable the GPI line indicated by - gpinum on matrix - matrix. - - - - - <command>GPI Set [GI]</command> - - - - Module - ripcd8 - - - Mnemonic - GI - - - - - Set action in response to a GPIO event. - - - GI - matrix - type - gpinum - state - cart! - - - Execute the macro cart cart upon transition - of the GPIO of type type and line - gpinum on matrix - matrix to state. - Possible types are: - - - - - I - Input - - - O - Output - - - - - - - <command>GPI Set [GI]</command> (old format, deprecated) - - - - Module - ripcd8 - - - Mnemonic - GI - - - - - Set action in response to a GPIO event. - - - GI - matrix - gpinum - state - cart! - - - Execute the macro cart cart upon transition - of the GPIO of line gpinum on matrix - matrix to state. - - - - - <command>GPO Set [GO]</command> - - - - Module - ripcd8 - - - Mnemonic - GO - - - - - Set the state of a GPIO line. - - - GO - matrix - type - gponum - state - length! - - - Command GPIO line gponum of type - type on matrix - matrix> to state - for length> mS. A length of - 0 indicates to hold the state indefinitely. - Possible types are: - - - - - I - Input - - - O - Output - - - - - Possible states are: - - - - - 0 - OFF - - - 1 - ON - - - -1 - Passthrough hardware input (valid only for Input type) - - - - - - - <command>GPO Set [GO]</command> (old format, deprecated) - - - - Module - ripcd8 - - - Mnemonic - GO - - - - - Set the state of a GPIO line. - - - GO - matrix - gponum - state - length! - - - Command GPIO line gponum on matrix - matrix> to state - for length> mS. A length of - 0 indicates to hold the state indefinitely. - - - - - <command>Insert Serial Trap [SI]</command> - - - - Module - ripcd8 - - - Mnemonic - SI - - - - - Insert a serial trap to detect a character sequence. - - - SI - portnum - cart - string! - - - Insert a serial trap to execute the macro cart - cart upon receipt of - string on serial port - port. - - - - - <command>Label Panel [PC]</command> - - - - Module - rdairplay1 - - - Mnemonic - PC - - - - - Set the label of a SoundPanel button in RDAirPlay. - - - PC - panel - col - row - label - color! - - - Set the button at col, - row of panel panel - to have a text label of label and a - background color of color. - Panel: S1...S50 or - U1...U50; - C for panel means - currently selected panel. - - - - - <command>Load Log [LL]</command> - - - - Module - rdairplay1 - - - Mnemonic - LL - - - - - Load a log into RDAirPlay. - - - LL - mach - [logname] - [startline]! - - - Load the log logname in log machine - mach. After loading, start the log at line - startline if it is >=0. If - startline is -2, the log will be started at - the first event if that event does not have a 'stop' transition. - Default startline=-1. If no - log> is specified, the machine's current log - is unloaded. - - - - - <command>Load Panel [PE]</command> - - - - Module - rdairplay1 - - - Mnemonic - PE - - - - - Load a cart into a SoundPanel button in RDAirPlay. - - - PE - panel - col - row - cart! - - - Load cart cart into the button at - col,row of panel - panel. - Panel: S1...S50 or - U1...U50; - C for panel means - currently selected panel. - - - - - <command>Load Slot [DL]</command> - - - - Module - rdcartslots1 - - - Mnemonic - DL - - - - - Load an RDCartSlots slot. - - - This command has two syntaxes, depending upon the mode of the slot. - - - Cart Deck Mode syntax: - - - DL - slot - cart! - - - Load the cart cart into the - slot slot. Passing a '0' for - cart will cause the slot to be unloaded. - This command will be ignored if the slot is currently playing. - - - Breakaway Mode syntax: - - - DL - slot - svcname! - - - Set the slot slot to use service - svcname. Omitting the - svcname argument will cause the slot to be - unloaded. This command will be ignored if the slot is currently - executing a breakaway. - - - - - <command>Login [LO]</command> - - - - Module - ripcd8 - - - Mnemonic - LO - - - - - Change the active Rivendell user context. - - - LO - user - password! - - - Set the current Rivendell user to user. - If no arguments are supplied, log out the station --i.e. revert to the - default user. - - - - - <command>Macro Timer [MT]</command> - - - - Module - ripcd8 - - - Mnemonic - MT - - - - - Timer for running macro carts. - - - MT - timernum - timeout - cart! - - - Set the macro timer timernum to execute macro - cart cart in - timeout milliseconds. Setting - timeout to 0 disables - the timer. Sixteen macro timers (numbered 1-16) are available on each - Rivendell host. - - - - - <command>Make Next [MN]</command> - - - - Module - rdairplay1 - - - Mnemonic - MN - - - - - Load changes to a currently loaded log in RDAirPlay. - - - RL - mach - line! - - - Set the next event for log machine mach to - line line>. - - - - - <command>Message Box [MB]</command> - - - - Module - ripcd8 - - - Mnemonic - MB - - - - - Display a popup message box on a host display. - - - MB - display - severity - msg! - - - Display the text msg in a popup window on X - display display, with an icon to indicate - severity. Valid values of - severity are: - - - - 1 - Information - - - 2 - Warning - - - 3 - Critical - - - - - - <command>Pause Panel [PU]</command> - - - - Module - rdairplay1 - - - Mnemonic - PU - - - - - Pause a SoundPanel button in RDAirPlay. - - - PU - panel - col - row - [mport]! - - - Pause the button at col, - row of panel panel. - Panel: S1...S50 or - U1...U50; - C for panel means - currently selected panel. - If col and/or row - is 0: pause all playing buttons in - col or row. - If specified, start the playout on panel port - mport. - - - - - <command>Play Panel [PP]</command> - - - - Module - rdairplay1 - - - Mnemonic - PP - - - - - Load a cart into a SoundPanel button in RDAirPlay. - - - PP - panel - col - row - [mport] - [0|1]! - - - Play the button at col, - row of panel panel. - Panel: S1...S50 or - U1...U50; - C for panel means - currently selected panel. - If col and/or row - is 0: Start the first loaded button that is not - active. If specified, start the playout on panel port - mport. The started panel will stay active when - finished, if the 5th argument is 1. - - - - - <command>Play Slot [DP]</command> - - - - Module - rdcartslots1 - - - Mnemonic - DP - - - - - Play an RDCartSlots slot. - - - DP - slot! - - - Play the cart currently loaded in the slot - slot. The slot must be in Cart Deck mode. This command will be - ignored if the slot is unloaded or already playing. - - - - - <command>Refresh Log [RL]</command> - - - - Module - rdairplay1 - - - Mnemonic - RL - - - - - Load changes to a currently loaded log in RDAirPlay. - - - RL - mach! - - - Refresh the log currently loaded in log machine - mach. - - - - - <command>Run Shell Command [RN]</command> - - - - Module - ripcd8 - - - Mnemonic - RN - - - - - Run a shell command. - - - RN - cmd! - - - Run the shell command cmd. - - - - - <command>Select Widget [PW]</command> - - - - Module - rdairplay1 - - - Mnemonic - PW - - - - - Select right-hand widget in RDAirPlay. - - - PW - mach! - - - Select right-hand widget to log-machine mach - or 0 for sound panel. - - - - - <command>Serial Out [SO]</command> - - - - Module - ripcd8 - - - Mnemonic - SO - - - - - Output a string on a serial port. - - - SO - portnum - data! - - - Output data on serial port - portnum. data can - consist of arbitrary binary data as well as textual characters (see - Binary Data above). - - - - - <command>Serial Reload [SY]</command> - - - - Module - ripcd8 - - - Mnemonic - SY - - - - - Reload the configuration for a serial port. - - - SY - portnum! - - - Reload the configuration for serial port - portnum. Normally, this should only be - issued by RDAdmin following a configuration change. - - - - - <command>Set Color Label [LC]</command> - - - - Module - rdairplay1 - - - Mnemonic - LC - - - - - Display a color message in the label widget on RDAirPlay. - - - LC - color - string! - - - Display string> in color - color in the message widget. - - - - - <command>Set Default Now & Next Cart [SN]</command> - - - - Module - rdairplay1 - - - Mnemonic - SN - - - - - Set the default Now & Next cart. - - - SN - now|next - mach - cart! - - - Set the default Now & Next cart for log - mach to cart. - - - - - <command>Set Display [SD]</command> - - - - Module - ripcd8 - - - Mnemonic - SD - - - - - Set a console display. - - - SD - matrix - display - line - col - attr - label! - - - On matrix matrix, set the console display - display to label, - starting at position line, - col and using message attributes - attr. - - - The message attributes value is constructed as follows: - - - - Bit 7 - Display mode - - - Bits 6,5 - Video attribute - - - Bit 2,1,0 - Message Text Color - - - - Display Mode: - - - - 0 - Overwrite text - - - 1 - Insert text - - - - Video Attribute: - - - - 00 - Normal - - - 01 - Flash - - - 02 - Reverse - - - - Text Color: - - - - 000 - White - - - 001 - Red - - - 010 - Yellow - - - 011 - Green - - - 100 - Cyan - - - 101 - Magenta - - - - - - <command>Set Duck Level [MD]</command> - - - - Module - rdairplay1 - - - Mnemonic - MD - - - - - Set duck level for an RDAirPlay log machine. - - - MD - mach - level - fade - [mport]! - - - Set the duck level of mach, or - 0 for all log machines. If playing, the audio - fades to level (in dbFS) in - fade msecs. If specified, only affect carts - playing on machine port mport. - Loading or clearing a log will set the duck level back to 0. - - - - - <command>Set Label [LB]</command> - - - - Module - rdairplay1 - - - Mnemonic - LB - - - - - Display a message in the label widget on RDAirPlay. - - - LB - string! - - - Display string> in the message widget. - - - - - <command>Set Mode [PM]</command> - - - - Module - rdairplay1 - - - Mnemonic - PM - - - - - Set the mode of an RDAirPlay log machine. - - - PM - mode - [mach]! - - - Set log machine mach to mode - mode. If mode is not given or the Mode - Control Style is set to 'Unified', then all log machines are set to - mode. Valid values for - mode are: - - - 1 - LiveAssist - - - 2 - Auto - - - 3 - Manual - - - - - - - <command>Sleep [SP]</command> - - - - Module - ripcd8 - - - Mnemonic - SP - - - - - Pause for specified time. - - - SP - msecs! - - - Wait for msecs milliseconds. - - - - - <command>Start [PL]</command> - - - - Module - rdairplay1 - - - Mnemonic - PL - - - - - Start a log at a specified line. - - - PL - mach - line! - - - Start log machine mach at line - line if stopped, otherwise do nothing. - - - - - <command>Start Button [PB]</command> - - - - Module - rdairplay1 - - - Mnemonic - PB - - - - - Push an RDAirPlay Start button. - - - PB - button! - - - Push button button. - - - - - <command>Start Next [PN]</command> - - - - Module - rdairplay1 - - - Mnemonic - PN - - - - - Start the next event in a log. - - - PN - mach - [mport] - [skip]! - - - Start log machine mach> if stopped, or start - next event if already running. If specified, start the playout on - machine port mport>. If - skip is supplied, equal to '1' and the log - machine is in Manual or Live Assist mode, then any intervening - meta-events in log between the current 'next' event and the next cart - will be skipped over. - - - - - <command>Start Record Deck [RS]</command> - - - - Module - rdcatchd8 - - - Mnemonic - RS - - - - - Start an RDCatch Recording - - - RS - decknum - cartnum - cutnum - maxlen! - - - Start recording to cut cutnum of cart - cartnum, using RDCatch record deck - decknum for a maximum time of - maxlen mS. The record parameters used - (format, sample rate, channels, etc) will be those configured for the - selected deck in RDAdmin->ManageHosts->RDCatch. The selected cart and - cut must already exist. Any audio previously residing in the selected - cart and cut will be overwritten. - - - - - <command>Stop [PS]</command> - - - - Module - rdairplay1 - - - Mnemonic - PS - - - - - Stop a log in RDAirPlay. - - - PS - mach|0 - [fade] - [mport]! - - - Stop log machine mach, or - 0 for all log machines. If specified, only stop - carts playing on machine port mport. If - specified, fade out fade msecs. - - - - - <command>Stop Panel [PT]</command> - - - - Module - rdairplay1 - - - Mnemonic - PT - - - - - Stop a SoundPanel button in RDAirPlay. - - - PT - panel - col - row - [mport] - [0|1] - fade! - - - Stop the button at col, - row of panel panel. - Panel: S1...S50 or - U1...U50; - C for panel means - currently selected panel. - If col and/or row - is 0: stop all playing buttons in - col or row. - If specified, start the playout on panel port - mport. The stopped panel will stay active when - finished, if the 5th argument is 1. - - - - - <command>Stop Record Deck [RR]</command> - - - - Module - rdcatchd8 - - - Mnemonic - RR - - - - - Stop an RDCatch Recording - - - RR - decknum! - - - Stop any active recording on RDCatch deck decknum. - - - - - <command>Stop Slot [DS]</command> - - - - Module - rdcartslots1 - - - Mnemonic - DS - - - - - Stop an RDCartSlots slot. - - - DS - slot! - - - Stop the cart currently loaded in the slot - slot. The slot must be in Cart Deck mode. This command will be - ignored if the slot is unloaded or already playing. - - - - - <command>Switch Add [SA]</command> - - - - Module - ripcd8 - - - Mnemonic - SA - - - - - Add an input to an output. - - - SA - matrix - input - output! - - - Command switch matrix number matrix to add - input number input to output number - output. Unlike SWITCH TAKE, - this command leaves any other previously assigned inputs unchanged. - - - - - <command>Switch Add With Gain [SG]</command> - - - - Module - ripcd8 - - - Mnemonic - SG - - - - - Add an input to an output while specifyng the crosspoint gain. - - - SG - matrix - input - output - gain! - - - Command switch matrix number matrix to add - input number input to output number - output at gain gain. - The gain is specified in 1/10 of a dB, with 0 = unity gain. - Unlike SWITCH TAKE, this command leaves any other - previously assigned inputs unchanged. - - - - - <command>Switch Crosspoint Gain [SX]</command> - - - - Module - ripcd8 - - - Mnemonic - SX - - - - - Set crosspoint gain. - - - SX - matrix - input - output - level! - - - Command switch matrix number matrix to adjust - the gain of the crosspoint connecting input - input to output - output to level dB. - - - - - <command>Switch Level [SL]</command> - - - - Module - ripcd8 - - - Mnemonic - SL - - - - - Set input gain. - - - SL - matrix - input - level! - - - Command switch matrix number matrix to adjust - the gain of input number input to - level dB. - - - - - <command>Switch Reload [SZ]</command> - - - - Module - ripcd8 - - - Mnemonic - SZ - - - - - Reload the configuration for a switch matrix. - - - SZ - matrix! - - - Reload the configuration for switch matrix - matrix. Normally, this should only be - issued by RDAdmin following a configuration change. - - - - - <command>Switch Remove [SR]</command> - - - - Module - ripcd8 - - - Mnemonic - SR - - - - - Remove an input from an output. - - - SR - matrix - input - output! - - - Command switch matrix number matrix to remove - input number input from output number - output. Unlike SWITCH TAKE, - this command leaves any other previously assigned inputs unchanged. - - - - - <command>Switch Take [ST]</command> - - - - Module - ripcd8 - - - Mnemonic - ST - - - - - Exclusively route an input to an output. - - - ST - matrix - input - output! - - - Command switch matrix number matrix to take - input number input to output number - output. "Take" in this context implies - removing any previously assigned inputs from the referenced output. - - - - - <command>Toggle On Air Flag [TA]</command> - - - - Module - ripcd8 - - - Mnemonic - TA - - - - - Set the state of the On Air flag. - - - TA 0|1! - - - Set the On-Air flag to ON [1] or OFF - [0]. - - - - - <command>UDP Out [UO]</command> - - - - Module - ripcd8 - - - Mnemonic - UO - - - - - Send data to a UDP port. - - - UO - ipaddr - udpport - data! - - - Send data in a UDP packet to port - udpport at ipaddr. - data can consist of arbitrary binary data as - well as textual characters (see Binary Data above). - - - - - -
diff --git a/docs/opsguide/Makefile.am b/docs/opsguide/Makefile.am index 1c95d034..956434a4 100644 --- a/docs/opsguide/Makefile.am +++ b/docs/opsguide/Makefile.am @@ -19,112 +19,212 @@ ## ## Use automake to process this into a Makefile.in -OPSGUIDE_DEPS = filepath_wildcards.xml\ +OPSGUIDE_HTML = appendix.filepath_wildcards.html\ + appendix.gpio_switcher_devices.html\ + appendix.gplv2.html\ + appendix.metadata_wildcards.html\ + chapter.overview.html\ + chapter.rdairplay.html\ + chapter.rdcatch.html\ + chapter.rdlibrary.html\ + chapter.rdlogedit.html\ + chapter.rdlogin.html\ + chapter.rdlogmanager.html\ + chapter.rml.html\ + chapter.utilities.html\ + chapter.voicetracking.html\ + index.html\ + sect.filepath_wildcards.examples.html\ + sect.gpio_switcher_devices.8x2.html\ + sect.gpio_switcher_devices.acu1p.html\ + sect.gpio_switcher_devices.bt10x1.html\ + sect.gpio_switcher_devices.bt16x1.html\ + sect.gpio_switcher_devices.bt16x2.html\ + sect.gpio_switcher_devices.btacs82.html\ + sect.gpio_switcher_devices.btadms4422.html\ + sect.gpio_switcher_devices.btgpi16.html\ + sect.gpio_switcher_devices.btsentinel4web.html\ + sect.gpio_switcher_devices.btsrc16.html\ + sect.gpio_switcher_devices.btss124.html\ + sect.gpio_switcher_devices.btss164.html\ + sect.gpio_switcher_devices.btss41mlr.html\ + sect.gpio_switcher_devices.btss42.html\ + sect.gpio_switcher_devices.btss44.html\ + sect.gpio_switcher_devices.btss82.html\ + sect.gpio_switcher_devices.btu41mlrweb.html\ + sect.gpio_switcher_devices.harlond.html\ + sect.gpio_switcher_devices.kernelgpio.html\ + sect.gpio_switcher_devices.livewire_lwrpaudio.html\ + sect.gpio_switcher_devices.livewire_lwrpgpio.html\ + sect.gpio_switcher_devices.livewire_mcastgpio.html\ + sect.gpio_switcher_devices.local_audio.html\ + sect.gpio_switcher_devices.local_gpio.html\ + sect.gpio_switcher_devices.modbus.html\ + sect.gpio_switcher_devices.modemlines.html\ + sect.gpio_switcher_devices.quartz1.html\ + sect.gpio_switcher_devices.rossnkscp.html\ + sect.gpio_switcher_devices.sas16000.html\ + sect.gpio_switcher_devices.sas32000.html\ + sect.gpio_switcher_devices.sas64000gpi.html\ + sect.gpio_switcher_devices.sas64000.html\ + sect.gpio_switcher_devices.sasusi.html\ + sect.gpio_switcher_devices.starguide3.html\ + sect.gpio_switcher_devices.swauthority.html\ + sect.gpio_switcher_devices.unity4000.html\ + sect.gpio_switcher_devices.vguest.html\ + sect.gpio_switcher_devices.wheatnet_lio.html\ + sect.gpio_switcher_devices.wheatnet_slio.html\ + sect.gplv2.how_to_apply_these_terms_to_your_new_programs.html\ + sect.rdairplay.editing_a_log.html\ + sect.rdairplay.layout.html\ + sect.rdairplay.log_machines.html\ + sect.rdcatch.adding_new_events.html\ + sect.rdcatch_automating_macro_execution.html\ + sect.rdcatch.automating_playouts.html\ + sect.rdcatch.automating_recordings.html\ + sect.rdcatch.automating_switcher_operations.html\ + sect.rdcatch.automating_uploads_downloads.html\ + sect.rdcatch.the_rdcatch_main_window.html\ + sect.rdlibrary.alternative_methods_of_audio_ingestion.html\ + sect.rdlibrary.generating_library_reports.html\ + sect.rdlibrary.library_maintenance.html\ + sect.rdlibrary.macro_carts.html\ + sect.rdlibrary.navigating_the_audio_library.html\ + sect.rdlogedit.auditioning_audio.html\ + sect.rdlogedit.editing_log_event_parameters.html\ + sect.rdlogedit.event_transitions.html\ + sect.rdlogedit.generating_log_reports.html\ + sect.rdlogedit.time_and_time_types.html\ + sect.rdlogmanager.clocks.html\ + sect.rdlogmanager.events.html\ + sect.rdlogmanager.generating_logs.html\ + sect.rdlogmanager.generating_reports.html\ + sect.rdlogmanager.grids.html\ + sect.rml.binary_data.html\ + sect.rml.command_delivery.html\ + sect.rml.command_reply.html\ + sect.rml.commands.html\ + sect.rml.protocol.html\ + sect.rml.specifying_color.html\ + sect.utilities.mlsend_1_.html\ + sect.utilities.rdconvert.html\ + sect.utilities.rddbcheck.html\ + sect.utilities.rdexport.html\ + sect.utilities.rdimport.html\ + sect.utilities.rdmarkerset.html\ + sect.utilities.rdrevert.html\ + sect.voicetracking.using_the_voicetracker_dialog.html + +OPSGUIDE_IMAGES = rdairplay.audio_meter.png\ + rdairplay.button_log_widget.png\ + rdairplay.delete_from.png\ + rdairplay.edit_button_dialog.png\ + rdairplay.edit_buttons.png\ + rdairplay.edit_event_dialog.png\ + rdairplay.full_log_widget.png\ + rdairplay.label_widget.png\ + rdairplay.mode_widget.png\ + rdairplay.next_stop_widget.png\ + rdairplay.piewedge_widget.png\ + rdairplay.postpoint_early_widget.png\ + rdairplay.postpoint_late_widget.png\ + rdairplay.postpoint_ontime_widget.png\ + rdairplay.rdairplay_screenshot.png\ + rdairplay.select_a_log_dialog.png\ + rdairplay.soundpanel_widget.png\ + rdairplay.wallclock_widget.png\ + rdairplay.where_to.png\ + rdcatch.add_event_dialog.png\ + rdcatch.edit_cart_event_dialog.png\ + rdcatch.edit_download_dialog.png\ + rdcatch.edit_playout_dialog.png\ + rdcatch.edit_recording_dialog.png\ + rdcatch.edit_switcher_event_dialog.png\ + rdcatch.edit_upload_dialog.png\ + rdcatch.rdcatch_screenshot.png\ + rdlibrary.cd_ripper_dialog.png\ + rdlibrary.edit_cart_dialog.png\ + rdlibrary.edit_cut_info_dialog.png\ + rdlibrary.edit_macro_cart_dialog.png\ + rdlibrary.edit_marker_dialog.png\ + rdlibrary.import_export_dialog.png\ + rdlibrary.rdlibrary_screenshot.png\ + rdlibrary.rip_disk_dialog.png\ + rdlibrary.set_cart_cut_dialog.png\ + rdlogedit.edit_log_chain_dialog.png\ + rdlogedit.edit_log_dialog.png\ + rdlogedit.edit_log_entry_dialog.png\ + rdlogedit.edit_log_marker_dialog.png\ + rdlogedit.edit_voice_track_marker_dialog.png\ + rdlogedit.rdlogedit_screenshot.png\ + rdlogedit.select_cart_dialog.png\ + rdlogin.rdlogin_screenshot.png\ + rdlogmanager.edit_clock_dialog.png\ + rdlogmanager.edit_event_assignment_dialog.png\ + rdlogmanager.edit_grid_dialog.png\ + rdlogmanager.editing_event.png\ + rdlogmanager.generate_log_dialog.png\ + rdlogmanager.generate_log_dialog_fully_merged.png\ + rdlogmanager.generate_log_dialog_music_merge_required.png\ + rdlogmanager.generate_log_dialog_traffic_merge_required.png\ + rdlogmanager.log_clock_list.png\ + rdlogmanager.log_clocks.png\ + rdlogmanager.log_events_dialog.png\ + rdlogmanager.log_grids_dialog.png\ + rdlogmanager.rdlogmanager_screenshot.png\ + rdlogmanager.rivendell_services_dialog.png\ + rdlogmanager.select_date_dialog.png\ + rdlogmanager.select_report_dates_dialog.png\ + rdlogmanager.service_association_dialog.png\ + voicetracking.voice_tracker_dialog.png\ + voicetracking.voice_tracker_dialog_recording.png\ + voicetracking.voice_tracker_dialog_track_1_playing.png\ + voicetracking.voice_tracker_dialog_track_2_playing.png\ + voicetracking.voice_tracker_dialog_track_completed.png\ + voicetracking.voice_tracker_dialog_track_selected.png + + +OPSGUIDE_DEPS = $(OPSGUIDE_IMAGES) \ + filepath_wildcards.xml\ gpio_switcher_devices.xml\ gplv2.xml\ opsguide.xml\ overview.xml\ metadata_wildcards.xml\ - rdairplay.audio_meter.png\ - rdairplay.button_log_widget.png\ - rdairplay.delete_from.png\ - rdairplay.edit_button_dialog.png\ - rdairplay.edit_buttons.png\ - rdairplay.edit_event_dialog.png\ - rdairplay.full_log_widget.png\ - rdairplay.label_widget.png\ - rdairplay.mode_widget.png\ - rdairplay.next_stop_widget.png\ - rdairplay.piewedge_widget.png\ - rdairplay.postpoint_early_widget.png\ - rdairplay.postpoint_late_widget.png\ - rdairplay.postpoint_ontime_widget.png\ - rdairplay.rdairplay_screenshot.png\ - rdairplay.select_a_log_dialog.png\ - rdairplay.soundpanel_widget.png\ - rdairplay.wallclock_widget.png\ - rdairplay.where_to.png\ rdairplay.xml\ - rdcatch.add_event_dialog.png\ - rdcatch.edit_cart_event_dialog.png\ - rdcatch.edit_download_dialog.png\ - rdcatch.edit_playout_dialog.png\ - rdcatch.edit_recording_dialog.png\ - rdcatch.edit_switcher_event_dialog.png\ - rdcatch.edit_upload_dialog.png\ - rdcatch.rdcatch_screenshot.png\ rdcatch.xml\ - rdlibrary.cd_ripper_dialog.png\ - rdlibrary.edit_cart_dialog.png\ - rdlibrary.edit_cut_info_dialog.png\ - rdlibrary.edit_macro_cart_dialog.png\ - rdlibrary.edit_marker_dialog.png\ - rdlibrary.import_export_dialog.png\ - rdlibrary.rdlibrary_screenshot.png\ - rdlibrary.rip_disk_dialog.png\ - rdlibrary.set_cart_cut_dialog.png\ rdlibrary.xml\ - rdlogedit.edit_log_chain_dialog.png\ - rdlogedit.edit_log_dialog.png\ - rdlogedit.edit_log_entry_dialog.png\ - rdlogedit.edit_log_marker_dialog.png\ - rdlogedit.edit_voice_track_marker_dialog.png\ - rdlogedit.rdlogedit_screenshot.png\ - rdlogedit.select_cart_dialog.png\ rdlogedit.xml\ - rdlogin.rdlogin_screenshot.png\ rdlogin.xml\ - rdlogmanager.edit_clock_dialog.png\ - rdlogmanager.edit_event_assignment_dialog.png\ - rdlogmanager.edit_grid_dialog.png\ - rdlogmanager.editing_event.png\ - rdlogmanager.generate_log_dialog.png\ - rdlogmanager.generate_log_dialog_fully_merged.png\ - rdlogmanager.generate_log_dialog_music_merge_required.png\ - rdlogmanager.generate_log_dialog_traffic_merge_required.png\ - rdlogmanager.log_clock_list.png\ - rdlogmanager.log_clocks.png\ - rdlogmanager.log_events_dialog.png\ - rdlogmanager.log_grids_dialog.png\ - rdlogmanager.rdlogmanager_screenshot.png\ - rdlogmanager.rivendell_services_dialog.png\ - rdlogmanager.select_date_dialog.png\ - rdlogmanager.select_report_dates_dialog.png\ - rdlogmanager.service_association_dialog.png\ rdlogmanager.xml\ rml.xml\ utilities.rmlsend_screenshot.png\ utilities.xml\ - voicetracking.voice_tracker_dialog.png\ - voicetracking.voice_tracker_dialog_recording.png\ - voicetracking.voice_tracker_dialog_track_1_playing.png\ - voicetracking.voice_tracker_dialog_track_2_playing.png\ - voicetracking.voice_tracker_dialog_track_completed.png\ - voicetracking.voice_tracker_dialog_track_selected.png\ voicetracking.xml -index.html: $(OPSGUIDE_DEPS) frontspiece.xml +%.html: $(OPSGUIDE_DEPS)\ + ../../PACKAGE_VERSION xsltproc ../stylesheets/book-xhtml.xml opsguide.xml -opsguide.pdf: $(OPSGUIDE_DEPS) frontspiece.xml\ +opsguide.pdf: $(OPSGUIDE_DEPS) ../../PACKAGE_VERSION\ ../stylesheets/book-fo.xml\ ../stylesheets/book-fo-titlepages.xsl xsltproc ../stylesheets/book-fo.xml opsguide.xml | fop - -pdf opsguide.pdf -all-local: index.html\ +all-local: $(OPSGUIDE_HTML) \ + $(OPSGUIDE_IMAGES) \ opsguide.pdf EXTRA_DIST = $(OPSGUIDE_DEPS)\ + $(OPSGUIDE_HTML)\ + frontspiece.xml\ frontspiece.xml.in\ - index.html\ opsguide.pdf CLEANFILES = *~\ *.html\ *.pdf -DISTCLEANFILES = frontspiece.xml - MAINTAINERCLEANFILES = *~\ *.1\ *.8\ @@ -132,4 +232,5 @@ MAINTAINERCLEANFILES = *~\ *.pdf\ aclocal.m4\ configure\ + frontspiece.xml\ Makefile.in diff --git a/docs/stylesheets/Makefile.am b/docs/stylesheets/Makefile.am index 9253c7c3..256f672c 100644 --- a/docs/stylesheets/Makefile.am +++ b/docs/stylesheets/Makefile.am @@ -22,18 +22,16 @@ all-local: book-fo-titlepages.xsl book-fo-titlepages.xsl: book-fo-titlepages-spec.xml - xsltproc -o book-fo-titlepages.xsl @DOCBOOK_STYLESHEETS@/template/titlepage.xsl book-fo-titlepages-spec.xml + xsltproc -o book-fo-titlepages.xsl ../../helpers/docbook/template/titlepage.xsl book-fo-titlepages-spec.xml -EXTRA_DIST = book-common.xml.in\ - book-fo.xml.in\ +EXTRA_DIST = book-common.xml\ + book-fo-titlepages.xsl\ + book-fo.xml\ book-fo-titlepages-spec.xml\ - book-xhtml.xml.in + book-xhtml.xml CLEANFILES = *~\ *.xsl -DISTCLEANFILES = book-common.xml\ - book-fo.xml\ - book-xhtml.xml MAINTAINERCLEANFILES = *~\ aclocal.m4\ configure\ diff --git a/docs/stylesheets/book-common.xml.in b/docs/stylesheets/book-common.xml similarity index 100% rename from docs/stylesheets/book-common.xml.in rename to docs/stylesheets/book-common.xml diff --git a/docs/stylesheets/book-fo.xml.in b/docs/stylesheets/book-fo.xml similarity index 92% rename from docs/stylesheets/book-fo.xml.in rename to docs/stylesheets/book-fo.xml index cdffbcfb..0d18eae8 100644 --- a/docs/stylesheets/book-fo.xml.in +++ b/docs/stylesheets/book-fo.xml @@ -24,7 +24,7 @@ - + diff --git a/docs/stylesheets/book-xhtml.xml.in b/docs/stylesheets/book-xhtml.xml similarity index 94% rename from docs/stylesheets/book-xhtml.xml.in rename to docs/stylesheets/book-xhtml.xml index 0d53c3ca..5d206f87 100644 --- a/docs/stylesheets/book-xhtml.xml.in +++ b/docs/stylesheets/book-xhtml.xml @@ -24,7 +24,7 @@ - + 1 diff --git a/helpers/Makefile.am b/helpers/Makefile.am index f1d2a1cd..326eeb19 100644 --- a/helpers/Makefile.am +++ b/helpers/Makefile.am @@ -44,6 +44,8 @@ CLEANFILES = *~\ *.tar.gz\ moc_* +DISTCLEANFILES = docbook + MAINTAINERCLEANFILES = *~\ *.tar.gz\ aclocal.m4\ diff --git a/rivendell.spec.in b/rivendell.spec.in index 102b7aa0..fea9bf2a 100644 --- a/rivendell.spec.in +++ b/rivendell.spec.in @@ -107,7 +107,12 @@ if test "@WIN32_SOURCE@" ; then mkdir -p $RPM_BUILD_ROOT/var/win32 cp @WIN32_SOURCE@ $RPM_BUILD_ROOT/var/win32/ fi - +mkdir -p $RPM_BUILD_ROOT/%{_datadir}/doc/rivendell-%{version}/opsguide/html +cp docs/opsguide/*.pdf $RPM_BUILD_ROOT/%{_datadir}/doc/rivendell-%{version}/opsguide/ +cp docs/opsguide/*.html $RPM_BUILD_ROOT/%{_datadir}/doc/rivendell-%{version}/opsguide/html/ +cp docs/opsguide/*.png $RPM_BUILD_ROOT/%{_datadir}/doc/rivendell-%{version}/opsguide/html +mkdir -p $RPM_BUILD_ROOT/%{_datadir}/doc/rivendell-%{version}/apis +cp docs/apis/*.pdf $RPM_BUILD_ROOT/%{_datadir}/doc/rivendell-%{version}/apis/ %post ldconfig @@ -379,9 +384,6 @@ rm -rf $RPM_BUILD_ROOT %doc docs/ripc.txt %doc docs/pam_rd.txt %doc docs/MESSAGE_BOX.txt -%doc docs/docbook/cae.pdf -%doc docs/docbook/rml.pdf -%doc docs/docbook/web_api.pdf %doc docs/tables/audio_perms.txt %doc docs/tables/audio_ports.txt %doc docs/tables/cart.txt @@ -439,6 +441,9 @@ rm -rf $RPM_BUILD_ROOT %doc scripts/rd_mysql_enable_host.sh %doc scripts/rd_backup_system.sh %doc scripts/rd_restore_system.sh +%{_datadir}/doc/rivendell-%{version}/apis/*.pdf +%{_datadir}/doc/rivendell-%{version}/opsguide/*.pdf +%{_datadir}/doc/rivendell-%{version}/opsguide/html/* %files base