diff options
| -rw-r--r-- | TODO | 24 | ||||
| -rw-r--r-- | man/miav.1 | 34 | ||||
| -rw-r--r-- | man/miav.5 | 34 | ||||
| -rw-r--r-- | man/miav.conf.1 | 187 | ||||
| -rw-r--r-- | man/miav.conf.5 | 187 |
5 files changed, 445 insertions, 21 deletions
@@ -13,6 +13,9 @@ http://www.linuxmanpages.com/man3/fame_start_frame.3.php // YUV420 format specification http://encyclopedia.laborlawtalk.com/YUV_4:2:0 +// man HOWTOs +http://www.cs.hmc.edu/qref/writing_man_pages.html +http://www.schweikhardt.net/man_page_howto.html open64 ? @@ -186,24 +189,3 @@ A cron job examines this folder regularly (test how often). If a file has been here for more than a week, the administrator is contacted by email. -========================================================================== - Semphores and mutexes in the client network architechture -========================================================================== -,-----------. -| DV stream | -`-----------' - | - V -,-----------. -| Decoder | -`-----------' - | \ - V \ -,-----------. \ -| Player | \ -`-----------' \ - \ ,-----------. - ->| Encoder | - `-----------' - - diff --git a/man/miav.1 b/man/miav.1 new file mode 100644 index 0000000..cb575d5 --- /dev/null +++ b/man/miav.1 @@ -0,0 +1,34 @@ +.\" Process this file with +.\" groff -man -Tascii miav.1 +.\" +.TH MIAV 1 "June 2005" Linux "User Manuals" +.SH NAME +MIaV \- The Multicast Image and Video project. +.SH SYNOPSIS +.B miav +[ client | server ] +.SH DESCRIPTION +MIaV \- The Multicast Image and Video project. +the client records video and sends it over the network to the server, +which then again encodes it to mpeg1 or mpeg4 and saves it to disk. +.SH OPTIONS +.TP +.B \-client or client +Invokes MIaV in client mode. +.TP +.B \-server or server +Invokes MIaV in server mode. +.SH FILES +.I /etc/miav.conf +.RS +The system wide configuration file. See +.BR miav.conf (1) +for further details. +.SH "SEE ALSO" +.BR miav.conf (1) +.SH BUGS +If started in server mode, with the configfile pointing at a +nonwriteable server logfile, no warnings or error will be +issued. Errors and warnings will simply be send to the great void. +.SH AUTHOR +Bent Bisballe <deva at aasimon dot org> diff --git a/man/miav.5 b/man/miav.5 new file mode 100644 index 0000000..cb575d5 --- /dev/null +++ b/man/miav.5 @@ -0,0 +1,34 @@ +.\" Process this file with +.\" groff -man -Tascii miav.1 +.\" +.TH MIAV 1 "June 2005" Linux "User Manuals" +.SH NAME +MIaV \- The Multicast Image and Video project. +.SH SYNOPSIS +.B miav +[ client | server ] +.SH DESCRIPTION +MIaV \- The Multicast Image and Video project. +the client records video and sends it over the network to the server, +which then again encodes it to mpeg1 or mpeg4 and saves it to disk. +.SH OPTIONS +.TP +.B \-client or client +Invokes MIaV in client mode. +.TP +.B \-server or server +Invokes MIaV in server mode. +.SH FILES +.I /etc/miav.conf +.RS +The system wide configuration file. See +.BR miav.conf (1) +for further details. +.SH "SEE ALSO" +.BR miav.conf (1) +.SH BUGS +If started in server mode, with the configfile pointing at a +nonwriteable server logfile, no warnings or error will be +issued. Errors and warnings will simply be send to the great void. +.SH AUTHOR +Bent Bisballe <deva at aasimon dot org> diff --git a/man/miav.conf.1 b/man/miav.conf.1 new file mode 100644 index 0000000..1719ea6 --- /dev/null +++ b/man/miav.conf.1 @@ -0,0 +1,187 @@ +.\" Process this file with +.\" groff -man -Tascii miav.conf.1 +.\" +.TH MIAV.CONF 1 "June 2005" Linux "User Manuals" +.SH NAME +MIaV \- The Multicast Image and Video project. Configuration file. +.SH SYNOPSIS +.B /etc/miav.conf +.SH FORMAT +.RS +.RE +.I [property] = [value] +.SH FORMAT EXPLANATION +.TP +.B property +is a string without quotes, containing only normal characters. It is +case sensitive. +.TP +.B value +is one of the following: +.RS +.I string +.RS +A string is a sequence of characters, double quoted, and not +containgning newlines. +.RE +.I integer +.RS +An integer is a normal number, without qoutations, it may only +contain the characters 0-9. +.RE +.I float +.RS +A float is a floating point value, written without qoutations and +using a dot as the decimal indetifier. +.RE +.I boolean +.RS +A boolean is a string written without quotation, the following +three is equivalent: +.I 1, true, yes. +The following three are equivalent: +.I 0, false, no. +.SH DESCRIPTION +.RS +.RE +MIaV \- The Multicast Image and Video project. + +The MIaV configuration file: + +.B Log files of the server and the client. +.RE +The values +.I client_log_file +and +.I server_log_file +needs to be set to a string (double qouted) containing a filename, +which is writable by the user the program is run by. Please note that +the +.I user +and +.I group +properties do not apply to the client. + +.B Cpr Database configuration. +.RE +The +.I cpr_host +property must be set to a string (double quoted) sontaining a valid +dns name for a cpr server. +The +.I cpr_port +is the port number on which to contact the cpr server, and the +.I cpr_timeout +property is the number of miliseconds before bailing out, if the cpr +server does not reply. + +.B Video source. +.RE +The +.I video_width +and +.I video_height +properties are integers setting the width and height of the client +window. + +.B Size of the screen in inches. +.RE +.I screensize +.I pixel_width +.I pixel_height + +.B Skip frames in the player. +.RE +.I player_skip_frames +Set to 1 if client is slow ( less than 1.5 ghz ) + +.B How and where to connect to the miav server? +.RE +.I server_addr +.I server_port + +.B Run the server as the following user: +.RE +.I server_user +.I server_group + +.B Where to store the files recieved by the server +.RE +.I server_root + +.B Video output controls. +.RE +.I frame_sequence +A sequence of I and P, where I is keyframes +which is fast to create, but uses a lot of discspace. +P uses changes since last frame, is more cpu intensive, but uses a +lot less diskspace than I frames + +.B Frame quality. +.RE +.I frame_quality +in % - 100% is best quality + +.B Encoder threads. +.RE +The number of threads started for parallel encoding on the server +(for multiprocessor systems) +.I encoding_threads + +.B Encoder codec. +.RE +Codec is one of the following: +"mpeg1" For use with mpeg1 encoding. +"mpeg4" for use with mpeg4 encoding +default is "mpeg1" +.I encoding_codec +.SH EXAMPLE +.RS +.RE +client_log_file = "/var/log/miav_client.log" +.RE +server_log_file = "/var/log/miav_server.log" + +cpr_host = "cpr.example.com" +.RE +cpr_port = 10301 +.RE +cpr_timeout = 10000 + +video_width = 720 +.RE +video_height = 576 + +screensize = 19.0 +.RE +pixel_width = 1024 +.RE +pixel_height = 768 + +player_skip_frames = no + +server_addr = "miav.example.com" +.RE +server_port = 18120 + +server_user = "miav" +.RE +server_group = "miav" + +server_root = "/var/miav_files" + +frame_sequence = "IPPPP" + +frame_quality = 85 + +encoding_threads = 1 + +encoding_codec = "mpeg4" +.SH FILES +.I /etc/miav.conf +.RS +The system wide configuration file. +.SH "SEE ALSO" +.BR miav (1) +.SH AUTHOR +Bent Bisballe <deva at aasimon dot org> diff --git a/man/miav.conf.5 b/man/miav.conf.5 new file mode 100644 index 0000000..1719ea6 --- /dev/null +++ b/man/miav.conf.5 @@ -0,0 +1,187 @@ +.\" Process this file with +.\" groff -man -Tascii miav.conf.1 +.\" +.TH MIAV.CONF 1 "June 2005" Linux "User Manuals" +.SH NAME +MIaV \- The Multicast Image and Video project. Configuration file. +.SH SYNOPSIS +.B /etc/miav.conf +.SH FORMAT +.RS +.RE +.I [property] = [value] +.SH FORMAT EXPLANATION +.TP +.B property +is a string without quotes, containing only normal characters. It is +case sensitive. +.TP +.B value +is one of the following: +.RS +.I string +.RS +A string is a sequence of characters, double quoted, and not +containgning newlines. +.RE +.I integer +.RS +An integer is a normal number, without qoutations, it may only +contain the characters 0-9. +.RE +.I float +.RS +A float is a floating point value, written without qoutations and +using a dot as the decimal indetifier. +.RE +.I boolean +.RS +A boolean is a string written without quotation, the following +three is equivalent: +.I 1, true, yes. +The following three are equivalent: +.I 0, false, no. +.SH DESCRIPTION +.RS +.RE +MIaV \- The Multicast Image and Video project. + +The MIaV configuration file: + +.B Log files of the server and the client. +.RE +The values +.I client_log_file +and +.I server_log_file +needs to be set to a string (double qouted) containing a filename, +which is writable by the user the program is run by. Please note that +the +.I user +and +.I group +properties do not apply to the client. + +.B Cpr Database configuration. +.RE +The +.I cpr_host +property must be set to a string (double quoted) sontaining a valid +dns name for a cpr server. +The +.I cpr_port +is the port number on which to contact the cpr server, and the +.I cpr_timeout +property is the number of miliseconds before bailing out, if the cpr +server does not reply. + +.B Video source. +.RE +The +.I video_width +and +.I video_height +properties are integers setting the width and height of the client +window. + +.B Size of the screen in inches. +.RE +.I screensize +.I pixel_width +.I pixel_height + +.B Skip frames in the player. +.RE +.I player_skip_frames +Set to 1 if client is slow ( less than 1.5 ghz ) + +.B How and where to connect to the miav server? +.RE +.I server_addr +.I server_port + +.B Run the server as the following user: +.RE +.I server_user +.I server_group + +.B Where to store the files recieved by the server +.RE +.I server_root + +.B Video output controls. +.RE +.I frame_sequence +A sequence of I and P, where I is keyframes +which is fast to create, but uses a lot of discspace. +P uses changes since last frame, is more cpu intensive, but uses a +lot less diskspace than I frames + +.B Frame quality. +.RE +.I frame_quality +in % - 100% is best quality + +.B Encoder threads. +.RE +The number of threads started for parallel encoding on the server +(for multiprocessor systems) +.I encoding_threads + +.B Encoder codec. +.RE +Codec is one of the following: +"mpeg1" For use with mpeg1 encoding. +"mpeg4" for use with mpeg4 encoding +default is "mpeg1" +.I encoding_codec +.SH EXAMPLE +.RS +.RE +client_log_file = "/var/log/miav_client.log" +.RE +server_log_file = "/var/log/miav_server.log" + +cpr_host = "cpr.example.com" +.RE +cpr_port = 10301 +.RE +cpr_timeout = 10000 + +video_width = 720 +.RE +video_height = 576 + +screensize = 19.0 +.RE +pixel_width = 1024 +.RE +pixel_height = 768 + +player_skip_frames = no + +server_addr = "miav.example.com" +.RE +server_port = 18120 + +server_user = "miav" +.RE +server_group = "miav" + +server_root = "/var/miav_files" + +frame_sequence = "IPPPP" + +frame_quality = 85 + +encoding_threads = 1 + +encoding_codec = "mpeg4" +.SH FILES +.I /etc/miav.conf +.RS +The system wide configuration file. +.SH "SEE ALSO" +.BR miav (1) +.SH AUTHOR +Bent Bisballe <deva at aasimon dot org> |