diff --git a/ChangeLog b/ChangeLog index 16c932c6..ef7942ba 100644 --- a/ChangeLog +++ b/ChangeLog @@ -15371,3 +15371,5 @@ * Added a 'setstartdate' command to rdclilogedit(1). 2016-07-21 Fred Gleason * Added a '--script' option to rdclilogedit(1). +2016-07-22 Fred Gleason + * Added a man page for rdclilogedit(1). diff --git a/docs/docbook/Makefile.am b/docs/docbook/Makefile.am index ade22bb0..6691b824 100644 --- a/docs/docbook/Makefile.am +++ b/docs/docbook/Makefile.am @@ -33,6 +33,7 @@ all-local: cae.html\ cae.pdf\ + rdclilogedit.1\ rdmarkerset.8\ rdrevert.8\ rdexport.1\ @@ -42,7 +43,8 @@ all-local: cae.html\ web_api.html\ web_api.pdf -man_MANS = rdexport.1\ +man_MANS = rdclilogedit.1\ + rdexport.1\ rdimport.1\ rdmarkerset.8\ rdrevert.8 @@ -50,6 +52,8 @@ man_MANS = rdexport.1\ EXTRA_DIST = cae.html\ cae.pdf\ cae.xml\ + rdclilogedit.1\ + rdclilogedit.xml\ rdmarkerset.8\ rdmarkerset.xml\ rdrevert.8\ diff --git a/docs/docbook/rdclilogedit.xml b/docs/docbook/rdclilogedit.xml new file mode 100644 index 00000000..e192b3f4 --- /dev/null +++ b/docs/docbook/rdclilogedit.xml @@ -0,0 +1,434 @@ + + + + + rdclilogedit + 1 + April 2016 + Linux Audio Manual + + + rdclilogedit + Command-line editor for Rivendell logs + + + + + Fred + Gleason + fredg@paravelsystems.com + + Application Author + + + + + + + rdclilogedit + OPTIONS + + + + + Description + + rdclilogedit1 is a command-line + editor for Rivendell logs. It is loosely styled after the venerable + ed1 command-line text editor. + + + + Options + + + + + + + + Suppress generation of the command-line prompt (often desiable + when driving rdclilogedit1 + from a script). + + + + + + + + Commands + + rdclilogedit1 supports the + notion of an 'edit buffer' into which Rivendell logs can be loaded, + modified and then saved back to the Rivendell database. The contents + of the edit buffer can be manipulated by means of simple textual commands + sent to STDIN. The following commands are supported: + + + + + addcart + line + cart-num + + + + Add a new cart event before line + line using cart + cart-num. + + + + + + addchain + line + log-name + + + + Add a new chain-to event before line + line pointing to + log-name. + + + + + + addmarker + line + + + + Add a new marker event before line line. + + + + + + addtrack + line + + + + Add a new track event before line line. + + + + + + bye + + + + Exit the program. + + + + + + exit + + + + Exit the program. + + + + + + header + + + + Print the header data for the currently loaded log. + + + + + + help + cmd-name + + + + Print help about command cmd-name. If + cmd-name is + omitted, print the full list of available commands. + + + + + + list + + + + Print the log in the edit buffer. + + + + + + listlogs + + + + Print a list of the available Rivendell logs. + + + + + + listservices + + + + Print a list of the available Rivendell services. + + + + + + load + log-name + + + + Load the log log-name + into the edit buffer. + + + + + + new + log-name + + + + Create a new, empty log called + log-name in the edit buffer. + + + + + + quit + + + + Exit the program. + + + + + + remove + line + + + + Remove the log event at line line in + the edit buffer. + + + + + + save + + + + Save the contents of the edit buffer. + + + + + + saveas + log-name + + + + Save the contents of the edit buffer to a new log called + log-name. + + + + + + setautorefresh + yes|no + + + + Set the state of the log's auto-refresh flag. + + + + + + setcart + line + cart-num + + + + Set the cart event at line line to use + cart number cart-num. + + + + + + setcomment + line + str + + + + Set the Comment field of the marker or track event at line + line to str. + + + + + + setdesc + str + + + + Set the Description field of the log to + str. + + + + + + setenddate + date + + + + Set the End Date of the log to date, + where date is in the format + YYYY-MM-DD. To clear the End Date + value completely, omit the date + parameter. + + + + + + setlabel + line + str + + + + Set the Label field of the chain-to or marker event at line + line to str. + + + + + + setpurgedate + date + + + + Set the Purge Date of the log to date, + where date is in the format + YYYY-MM-DD. To clear the Purge Date + value completely, omit the date + parameter. + + + + + + setservice + str + + + + Set the log's owning Service to str. + (To print a list of valid Service names, see + listservices). + + + + + + setstartdate + date + + + + Set the Start Date of the log to date, + where date is in the format + YYYY-MM-DD. To clear the Start Date + value completely, omit the date + parameter. + + + + + + settime + line + hard|none + time + + + + Set the start time type and value for a log event. When + specifying a type of hard, the + time value (format + HH:MM:SS) must also be specified. + + + + + + settrans + line + play|segue|stop + + + + Set the transition type for a log event. + + + + + + unload + + + + Unload and clear the contents of the edit buffer. + + + + + + + +Bugs + + rdclilogedit1 has no ability + to create or edit log link events (such as Music or Traffic links). + + + + +