git.sesse.net Git - cubemap/blob - cubemap.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" (C) Copyright 2013 Philipp Kern <pkern@debian.org>,
   3 .\" licensed under the GPL-2 or any later version.
   4 .\"
   5 .TH CUBEMAP 1 "August 17, 2013"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .SH NAME
   8 cubemap \- scalable video reflector, designed to be used with VLC
   9 .SH SYNOPSIS
  10 .B cubemap
  11 .RI [ options ]
  12 .RI [ FILE ]
  13 .SH DESCRIPTION
  14 .B cubemap
  15 is a high-performance, high-availability video reflector,
  16 specifically made for use with VLC.
  17 .PP
  18 .IP \[bu] 2
  19 High-performance, through a design with multiple worker threads,
  20 epoll and sendfile (yes, sendfile); a 2GHz quadcore can saturate
  21 10 gigabit Ethernet, given a modern kernel, a modern NIC
  22 and the right kernel tuning.
  23 .IP \[bu]
  24 High-availability. You can change any part of the configuration
  25 (and even upgrade to a newer version of Cubemap) by changing cubemap.config
  26 and sending a SIGHUP; all clients will continue as if nothing had happened
  27 (unless you delete the stream they are watching, of course).
  28 Cubemap also survives the encoder dying and reconnecting.
  29 .IP \[bu]
  30 Per-stream fwmark support, for TCP pacing through tc (separate config needed).
  31 .IP \[bu]
  32 Support for setting max pacing rate through the fq packet scheduler
  33 (obsoletes the previous point, but depends on Linux 3.13 or newer).
  34 .IP \[bu]
  35 Reflects anything VLC can reflect over HTTP, even the muxes VLC
  36 has problems reflecting itself (in particular, FLV).
  37 .IP \[bu]
  38 IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
  39 .SH OPTIONS
  40 .TP
  41 \fB\-\-test\-config\fR, \fB\-t\fR
  42 tests the config and exits
  43 .TP
  44 \fBFILE\fR
  45 configuration file (defaults to cubemap.config in the current directory)
  46 .SH AUTHOR
  47 .B cubemap
  48 was written by Steinar H. Gunderson <sgunderson@bigfoot.com>.
  49 .SH LICENSE
  50 cubemap is licensed under the GNU General Public License, version 2.
  51 .SH SEE ALSO
  52 .BR vlc (1)