mirror of
https://github.com/pikvm/ustreamer.git
synced 2026-02-28 20:56:33 +00:00
help fix
This commit is contained in:
Devaev Maxim
@@ -7,25 +7,26 @@ ustreamer-dump \- Dump uStreamer's memory sink to file
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B ustreamer-dump
|
||||
.RI [OPTION]
|
||||
.RI [OPTIONS]
|
||||
|
||||
.SH DESCRIPTION
|
||||
µStreamer-dump (\fBustreamer-dump\fP) writes a local stream from ustreamer to a file or redirect it to other utilities (such as \fBffmpeg\fR).
|
||||
|
||||
.SH USAGE
|
||||
\fBustreamer\fR requires at least the \fB\-\-sink\fR option to operate.
|
||||
\fBustreamer\fR requires at least the \fB\-\-???\-sink\fR option to operate.
|
||||
|
||||
To output ustreamers sink "test" to ffmpeg, and into a file called test.mp4:
|
||||
|
||||
\fBustreamer-dump \e\fR
|
||||
.RS
|
||||
\fB\-\-sink=test \e\fR # Use ustreamer sink "test"
|
||||
.nf
|
||||
\fB\-\-output\ \- \e\fR # Output to stdout
|
||||
\fB\ |\ ffmpeg\ \-use_wallclock_as_timestamps\ 1\ \-i\ pipe:\ \-c:v\ libx264\ test\.mp4\fR
|
||||
\fB|\ ffmpeg\ \-use_wallclock_as_timestamps\ 1\ \-i\ pipe:\ \-c:v\ libx264\ test\.mp4\fR
|
||||
|
||||
.SH OPTIONS
|
||||
.SS "Sink options"
|
||||
|
||||
.TP
|
||||
.BR \-s ", " \-\-sink\ \fIname
|
||||
Memory sink ID. No default.
|
||||
.TP
|
||||
@@ -39,6 +40,7 @@ Filename to dump output to. Use '-' for stdout. Default: just consume the sink.
|
||||
Format output as JSON. Required option --output. Default: disabled.
|
||||
|
||||
.SS "Logging options"
|
||||
.TP
|
||||
.BR \-\-log\-level\ \fIN
|
||||
Verbosity level of messages from 0 (info) to 3 (debug). Enabling debugging messages can slow down the program.
|
||||
Available levels: 0 (info), 1 (performance), 2 (verbose), 3 (debug).
|
||||
@@ -60,12 +62,16 @@ Force color logging. Default: colored if stderr is a TTY.
|
||||
Disable color logging. Default: ditto.
|
||||
|
||||
.SS "Help options"
|
||||
.TP
|
||||
.BR \-h ", " \-\-help
|
||||
Print this text and exit.
|
||||
.TP
|
||||
.BR \-v ", " \-\-version
|
||||
Print version and exit.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
.BR ustreamer (1)
|
||||
|
||||
.SH BUGS
|
||||
Please file any bugs and issues at \fIhttps://github.com/pikvm/ustreamer/issues\fR
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ ustreamer \- stream MJPG video from any V4L2 device to the network
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B ustreamer
|
||||
.RI [OPTION]
|
||||
.RI [OPTIONS]
|
||||
|
||||
.SH DESCRIPTION
|
||||
µStreamer (\fBustreamer\fP) is a lightweight and very quick server to stream MJPG video from any V4L2 device to the network. All new browsers have native support of this video format, as well as most video players such as mplayer, VLC etc. µStreamer is a part of the Pi-KVM project designed to stream VGA and HDMI screencast hardware data with the highest resolution and FPS possible.
|
||||
@@ -40,6 +40,7 @@ You can always view the full list of options with \fBustreamer \-\-help\fR\. Som
|
||||
|
||||
.SH OPTIONS
|
||||
.SS "Capturing options"
|
||||
.TP
|
||||
.BR \-d\ \fI/dev/path ", " \-\-device\ \fI/dev/path
|
||||
Path to V4L2 device. Default: /dev/video0.
|
||||
.TP
|
||||
@@ -97,7 +98,7 @@ HW ─ Use pre-encoded MJPG frames directly from camera hardware.
|
||||
NOOP ─ Don't compress MJPG stream (do nothing).
|
||||
.TP
|
||||
.BR \-g\ \fIWxH,... ", " \-\-glitched\-resolutions\ \fIWxH,...
|
||||
It doesn't do anything. Still here for compatibility. Required \fBWITH_OMX\fR feature. Default: disabled.
|
||||
It doesn't do anything. Still here for compatibility. Required \fBWITH_OMX\fR feature.
|
||||
.TP
|
||||
.BR \-k\ \fIpath ", " \-\-blank\ \fIpath
|
||||
Path to JPEG file that will be shown when the device is disconnected during the streaming. Default: black screen 640x480 with 'NO SIGNAL'.
|
||||
@@ -112,6 +113,7 @@ Timeout for device querying. Default: 1.
|
||||
Delay before trying to connect to the device again after an error (timeout for example). Default: 1.
|
||||
|
||||
.SS "Image control options"
|
||||
.TP
|
||||
.BR \-\-image\-default
|
||||
Reset all image settings bellow to default. Default: no change.
|
||||
.TP
|
||||
@@ -152,6 +154,7 @@ Set vertical flip. Default: no change.
|
||||
Set horizontal flip. Default: no change.
|
||||
|
||||
.SS "HTTP server options"
|
||||
.TP
|
||||
.BR \-s\ \fIaddress ", " \-\-host\ \fIaddress
|
||||
Listen on Hostname or IP. Default: 127.0.0.1.
|
||||
.TP
|
||||
@@ -196,6 +199,8 @@ Set Access\-Control\-Allow\-Origin header. Default: disabled.
|
||||
Timeout for client connections. Default: 10.
|
||||
|
||||
.SS "JPEG sink options"
|
||||
With shared memory sink you can write a stream to a file. See \fBustreamer-dump\fR(1) for more info.
|
||||
.TP
|
||||
.BR \-\-jpeg\-sink\ \fIname
|
||||
Use the specified shared memory object to sink JPEG frames. Default: disabled.
|
||||
.TP
|
||||
@@ -209,6 +214,7 @@ Remove shared memory on stop. Default: disabled.
|
||||
Timeout for lock. Default: 1.
|
||||
|
||||
.SS "H264 sink options"
|
||||
.TP
|
||||
Available only if \fBWITH_OMX\fR feature enabled.
|
||||
.TP
|
||||
.BR \-\-h264\-sink\ \fIname
|
||||
@@ -224,6 +230,7 @@ Remove shared memory on stop. Default: disabled.
|
||||
Timeout for lock. Default: 1.
|
||||
|
||||
.SS "Process options"
|
||||
.TP
|
||||
.BR \-\-exit\-on\-parent\-death
|
||||
Exit the program if the parent process is dead. Required \fBHAS_PDEATHSIG\fR feature. Default: disabled.
|
||||
.TP
|
||||
@@ -252,6 +259,7 @@ Set 1 while streaming. Default: disabled.
|
||||
Set 1 while stream has at least one client. Default: disabled.
|
||||
|
||||
.SS "Logging options"
|
||||
.TP
|
||||
.BR \-\-log\-level\ \fIN
|
||||
Verbosity level of messages from 0 (info) to 3 (debug). Enabling debugging messages can slow down the program.
|
||||
Available levels: 0 (info), 1 (performance), 2 (verbose), 3 (debug).
|
||||
@@ -273,6 +281,7 @@ Force color logging. Default: colored if stderr is a TTY.
|
||||
Disable color logging. Default: ditto.
|
||||
|
||||
.SS "Help options"
|
||||
.TP
|
||||
.BR \-h ", " \-\-help
|
||||
Print this text and exit.
|
||||
.TP
|
||||
@@ -282,6 +291,9 @@ Print version and exit.
|
||||
.BR \-\-features
|
||||
Print list of supported features.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
.BR ustreamer-dump (1)
|
||||
|
||||
.SH BUGS
|
||||
Please file any bugs and issues at \fIhttps://github.com/pikvm/ustreamer/issues\fR
|
||||
|
||||
|
||||
@@ -609,7 +609,7 @@ static void _help(FILE *fp, device_s *dev, encoder_s *enc, stream_s *stream, ser
|
||||
SAY(" * HW ─── Use pre-encoded MJPG frames directly from camera hardware.");
|
||||
SAY(" * NOOP ─ Don't compress MJPG stream (do nothing).\n");
|
||||
# ifdef WITH_OMX
|
||||
SAY(" -g|--glitched-resolutions <WxH,...> ─ It doesn't do anything. Still here for compatibility. Default: disabled.\n");
|
||||
SAY(" -g|--glitched-resolutions <WxH,...> ─ It doesn't do anything. Still here for compatibility.\n");
|
||||
# endif
|
||||
SAY(" -k|--blank <path> ─────────────────── Path to JPEG file that will be shown when the device is disconnected");
|
||||
SAY(" during the streaming. Default: black screen 640x480 with 'NO SIGNAL'.\n");
|
||||
|
||||
Reference in New Issue
Block a user