Permalink
Browse files

Add a manpage for vlc-wrapper

(cherry picked from commit 374338c)
(cherry picked from commit 9beed2d)
  • Loading branch information...
1 parent 6680e8d commit dd90abe6c6e2fa42392c5b2425803d44295ca7ee Christophe Mutricy committed Jan 21, 2009
Showing with 55 additions and 0 deletions.
  1. +1 −0 doc/Makefile.am
  2. +54 −0 doc/vlc-wrapper.1
View
@@ -23,6 +23,7 @@ CHANGELOGS = \
EXTRA_DIST = \
$(CHANGELOGS) \
vlc.1 \
+ vlc-wrapper.1 \
vlc-config.1 \
bugreport-howto.txt \
fortunes.txt \
View
@@ -0,0 +1,54 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH VLC\-WRAPPER 1 "Aug 31, 2008"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+vlc-wrapper \- a wrapper to drop priviledges with VLC
+.SH SYNOPSIS
+.B vlc-wrapper
+.RI [ OPTIONS ]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B VLC
+wrapper to open priviledged network ports.
+The ports it can open are 80, 443 and 554.
+
+.SH OPTIONS
+They will be passed to
+.B VLC
+with no modification.
+
+.SH USAGE
+.PP
+The preferred way is to use
+.B sudo
+:
+.PP
+\& $ sudo vlc-wrapper --option1 --option2
+.PP
+You can also set the SUDO_UID environement variable:
+.PP
+\& # SUDO_UID=1000 vlc-wrapper --option1 --option2
+.PP
+
+
+.SH SEE ALSO
+.BR vlc (1),
+.BR sudo (8)
+
+.PP
+.SH AUTHOR
+This manual page was written by Christophe Mutricy.

0 comments on commit dd90abe

Please sign in to comment.