.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH HARVID "1" "December 2022" "harvid v0.9.1" "User Commands"
.SH NAME
harvid \- video server
.SH SYNOPSIS
.B harvid
[\fI\,OPTION\/\fR] [\fI\,document-root\/\fR]
.SH DESCRIPTION
harvid \- http ardour video server
.SH OPTIONS
.TP
\fB\-A\fR <cmdlist>, \fB\-\-admin\fR <cmdlist>
space separated list of allowed admin commands.
An exclamation\-mark before a command disables it.
default: 'flush_cache';
available: flush_cache, purge_cache, shutdown
.TP
\fB\-c\fR <path>, \fB\-\-chroot\fR <path>
change system root \- jails server to this path
.TP
\fB\-C\fR <frames>
set initial frame\-cache size (default: 128)
.TP
\fB\-D\fR, \fB\-\-daemonize\fR
fork into background and detach from TTY
.TP
\fB\-g\fR <name>, \fB\-\-groupname\fR <name>
assume this user\-group
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit
.TP
\fB\-F\fR <feat>, \fB\-\-features\fR <feat>
space separated list of optional features.
An exclamation\-mark before a features disables it.
default: 'index';
available: index, seek, flatindex, keepraw
.TP
\fB\-l\fR <path>, \fB\-\-logfile\fR <path>
specify file for log messages
.TP
\fB\-M\fR, \fB\-\-memlock\fR
attempt to lock memory (prevent cache paging)
.TP
\fB\-p\fR <num>, \fB\-\-port\fR <num>
TCP port to listen on (default 1554)
.TP
\fB\-P\fR <listenaddr>
IP address to listen on (default 0.0.0.0)
.TP
\fB\-q\fR, \fB\-\-quiet\fR, \fB\-\-silent\fR
inhibit usual output (may be used thrice)
.TP
\fB\-s\fR, \fB\-\-syslog\fR
send messages to syslog
.TP
\fB\-t\fR <thread\-limit>
set maximum decoder\-threads (default: 8)
.TP
\fB\-T\fR <sec>, \fB\-\-timeout\fR <secs>
set a timeout after which the server will
terminate if no new request arrives
.TP
\fB\-u\fR <name>, \fB\-\-username\fR <name>
server will act as this user
.TP
\fB\-v\fR, \fB\-\-verbose\fR
print more information (may be used twice)
.TP
\fB\-V\fR, \fB\-\-version\fR
print version information and exit
.PP
The default document\-root (if unspecified) is the system root: / or C:\e.
.PP
If both syslog and logfile are given that last specified option will be used.
.PP
\fB\-\-verbose\fR and \fB\-\-quiet\fR are additive. The default is to print warnings
and above only. Available log\-levels are 'mute', 'critical, 'error',
\&'warning' and 'info'.
.PP
The \fB\-\-features\fR option allows one to enable or disable \fI\,/seek\/\fP and \fI\,/index\/\fP
http\-handlers and change their respone: The 'flatindex' option concerns
/index&flatindex=1 which recursively indexes all video file. It is disabled
by defaults since a recursive search of the default docroot / can takes a
very long time.
When requesting png or jpeg images harvid decodes a raw RGB frame and then
encodes it again. If 'keepraw' feature is enabled, both the raw RGB and
encoded image are kept in cache. The default is to invaldate the RGB frame
after encoding the image.
.SH EXAMPLES
harvid \-A '!flush_cache purge_cache shutdown' \-C 256 /tmp/
.PP
sudo harvid \-c /tmp/ \-u nobody \-g nogroup /
.SH "REPORTING BUGS"
Report bugs to <robin@gareus.org> or https://github.com/x42/harvid/issues
.br
Website http://x42.github.com/harvid/
.PP
.br
Compiled with Lavf58.45.100 Lavc58.91.100 Lavu56.51.100
.SH COPYRIGHT
Copyright \(co GPL 2002\-2013, 2022 Robin Gareus <robin@gareus.org>