doc/vlc-wrapper.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH VLC\-WRAPPER 1 "Aug 31, 2008"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 vlc-wrapper \- a wrapper to drop priviledges with VLC
  20 .SH SYNOPSIS
  21 .B vlc-wrapper
  22 .RI [ OPTIONS ]
  23 .SH DESCRIPTION
  24 This manual page documents briefly the
  25 .B VLC
  26 wrapper to open priviledged network ports.
  27 The ports it can open are 80, 443 and 554.
  28
  29 .SH OPTIONS
  30 They will be passed to
  31 .B VLC
  32 with no modification.
  33
  34 .SH USAGE
  35 .PP
  36 The preferred way is to use
  37 .B sudo
  38 :
  39 .PP
  40 \& $ sudo vlc-wrapper \-\-option1 \-\-option2
  41 .PP
  42 You can also set the SUDO_UID environment variable:
  43 .PP
  44 \& # SUDO_UID=1000 vlc-wrapper \-\-option1 \-\-option2
  45 .PP
  46
  47
  48 .SH SEE ALSO
  49 .BR vlc (1),
  50 .BR sudo (8)
  51
  52 .PP
  53 .SH AUTHOR
  54 This manual page was written by Christophe Mutricy.