Add a manual page for cubemap.
authorPhilipp Kern <pkern@debian.org>
Fri, 16 Aug 2013 22:14:24 +0000 (00:14 +0200)
committerSteinar H. Gunderson <sgunderson@bigfoot.com>
Sat, 17 Aug 2013 00:56:28 +0000 (02:56 +0200)
Makefile
cubemap.1 [new file with mode: 0644]

index 65a652d..e90ebb3 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -27,7 +27,7 @@ clean:
 
 PREFIX=/usr/local
 install:
-       $(INSTALL) -m 755 -o root -g root -d $(DESTDIR)$(PREFIX)/bin $(DESTDIR)/etc $(DESTDIR)/var/lib/cubemap $(DESTDIR)/var/log/cubemap
+       $(INSTALL) -m 755 -o root -g root -d $(DESTDIR)$(PREFIX)/bin $(DESTDIR)$(PREFIX)/share/man/man1 $(DESTDIR)/etc $(DESTDIR)/var/lib/cubemap $(DESTDIR)/var/log/cubemap
        $(INSTALL) -m 755 -o root -g root cubemap $(DESTDIR)$(PREFIX)/bin/cubemap
        sed \
                -e 's,cubemap\.stats,/var/lib/cubemap/\0,g' \
@@ -37,6 +37,7 @@ install:
                -e 's,^stream,#\0,g' \
                -e 's,^udpstream,#\0,g' \
                cubemap.config.sample > $(DESTDIR)/etc/cubemap.config
+       gzip -c cubemap.1 > $(DESTDIR)$(PREFIX)/share/man/man1/cubemap.1.gz
 
 .PHONY: clean install
 .SUFFIXES:
diff --git a/cubemap.1 b/cubemap.1
new file mode 100644 (file)
index 0000000..329180d
--- /dev/null
+++ b/cubemap.1
@@ -0,0 +1,49 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" (C) Copyright 2013 Philipp Kern <pkern@debian.org>,
+.\" licensed under the GPL-2 or any later version.
+.\"
+.TH CUBEMAP 1 "August 17, 2013"
+.\" Please adjust this date whenever revising the manpage.
+.SH NAME
+cubemap \- scalable video reflector, designed to be used with VLC
+.SH SYNOPSIS
+.B cubemap
+.RI [ options ]
+.RI [ FILE ]
+.SH DESCRIPTION
+.B cubemap
+is a high-performance, high-availability video reflector,
+specifically made for use with VLC. It is currently in alpha stage.
+.PP
+.IP \[bu] 2
+High-performance, through a design with multiple worker threads,
+epoll and sendfile (yes, sendfile); a 2GHz quadcore can saturate
+10 gigabit Ethernet, given a modern kernel, a modern NIC
+and the right kernel tuning.
+.IP \[bu]
+High-availability. You can change any part of the configuration
+(and even upgrade to a newer version of Cubemap) by changing cubemap.config
+and sending a SIGHUP; all clients will continue as if nothing had happened
+(unless you delete the stream they are watching, of course).
+Cubemap also survives the encoder dying and reconnecting.
+.IP \[bu]
+Per-stream fwmark support, for TCP pacing through tc (separate config needed).
+.IP \[bu]
+Reflects anything VLC can reflect over HTTP, even the muxes VLC
+has problems reflecting itself (in particular, FLV).
+.IP \[bu]
+IPv4 support. Yes, Cubemap even supports (some) legacy protocols.
+.SH OPTIONS
+.TP
+\fB\-\-test\-config\fR, \fB\-t\fR
+tests the config and exits
+.TP
+\fBFILE\fR
+configuration file (defaults to cubemap.config in the current directory)
+.SH AUTHOR
+.B cubemap
+was written by Steinar H. Gunderson <sesse@debian.org>.
+.SH LICENSE
+cubemap is licensed under the GNU General Public License, version 2.
+.SH SEE ALSO
+.BR vlc (1)