Add broadcasterctl

broadcasterctl/broadcasterctl.1

@@ -0,0 +1,125 @@
+.TH BROADCASTERCTL 1 "August 16, 2002" "Apple Computer, Inc."
+.SH NAME
+broadcasterctl \- controller for the QuickTime Broadcaster
+.SH SYNOPSIS
+.B broadcasterctl
+[-b broadcaster-path] [-a audiopreset] [-v videopreset] [-n networkpreset] 
+[-t (audio|video|av)] [-r (record|norecord)] [-p recording-path] [-f settingsfile]
+(config|status|presets|launch|start|stop|restart|quit)
+.SH DESCRIPTION
+.I broadcasterctl
+is a command line tool for controlling the
+.I QuickTime Broadcaster
+application. Using
+.I broadcasterctl
+you can configure, launch, start, and stop a 
+.SM QuickTime
+streaming broadcast generated by the
+.SM MacOS X
+.I QuickTime Broadcaster
+application.
+.PP
+The
+.I QuickTime Broadcaster
+application must be accessable on the local host on which the terminal session is exectuting in order to
+communicate with that application. (i.e. It will not control a network remote copy of the
+application.)
+.SH OPTIONS
+.PP
+The following command line options can be invoked with
+.I broadcasterctl:
+.TP
+.B config
+Sets the configuration of the
+.I QuickTime Broadcaster
+application to be that of the currently specified settings file.
+.TP
+.B status
+Returns the current status
+.I QuickTime Broadcaster
+application.
+.TP
+.B presets
+Sets the presets of the
+.I QuickTime Broadcaster
+application to be that of the currently specified preset values.
+.TP
+.B launch
+Launches the
+.I QuickTime Broadcaster
+application.
+.TP
+.B start
+Tells the 
+.I QuickTime Broadcaster
+application to begin the broadcast.
+.TP
+.B stop
+Tells the 
+.I QuickTime Broadcaster
+application to stop the broadcast.
+.TP
+.B restart
+Tells the 
+.I QuickTime Broadcaster
+application to restart the broadcast.
+.TP
+.B quit
+Causes the 
+.I QuickTime Broadcaster
+application to quit.
+.TP
+.BI \-a " audiopreset"
+Specifies the the current audio preset configuration to be the name given in
+the 
+.I audiopreset 
+parameter.
+.TP
+.BI \-b " broadcaster-path"
+Specifies the file path to the
+.I QuickTime Broadcaster
+application.
+.TP
+.BI \-f " settingsfile"
+Specifies the file path to the broadcast settings file.
+.TP
+.BI \-n " networkpreset"
+Specifies the the current network preset configuration to be the name given in
+the 
+.I networkpreset 
+parameter.
+.TP
+.BI \-p " recording-path"
+Specifies the file path to record the broadcast to.
+.TP
+.BI \-r " (record|norecord)"
+Controls whether or not the 
+.I QuickTime Broadcaster
+will record the broadcast to a file as it is broadcasting 
+the stream. Specify
+.I record 
+to record the broadcast and
+.I norecord
+to do nothing. (The default is the
+.I norecord
+option.)
+.TP
+.BI \-t " (audio|video|av)"
+Specifies the type of broadcast to be originated. Specifiy
+.I audio 
+for an audio-only broadcast,
+.I video
+for an video-only broadcast, or
+.I av
+for a combination audio/video broadcast.
+.TP
+.BI \-v " videopreset"
+Specifies the the current video preset configuration to be the name given in
+the 
+.I videopreset 
+parameter.
+.SH "SEE ALSO"
+QuickTimeStreamingServer(1), ps(1), kill(1)
+.SH LIMITATIONS
+Only one audio, video, or audio/video session can be controlled per invokation of
+.I broadcasterctl.