src/install/fstab/captive-install-fstab.pod.pl.in

   1 #! /usr/bin/perl
   2 #
   3 # $Id$
   4 # perlpod(1) source for captive-install-fstab(1) man page
   5 # Copyright (C) 2003 Jan Kratochvil <project-captive@jankratochvil.net>
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; exactly version 2 of June 1991 is required
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20
  21 use vars qw($VERSION);
  22 $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
  23 use strict;
  24 use warnings;
  25
  26
  27 print <<'POD_EOF';
  28 =head1 NAME
  29
  30 @PACKAGE@-install-fstab - Manage B<@PACKAGE@-ntfs> B</etc/fstab> entries
  31
  32
  33 =head1 SYNOPSIS
  34
  35 =for man
  36 \fB@PACKAGE@-install-fstab\fP [\fB-v\fP|\fB--verbose\fP] [\fB-n\fP|\fB--dry\fP]
  37 {\fB--add\fP|\fB--remove\fP}
  38
  39
  40 =head1 DESCRIPTION
  41
  42 Program will scan your local disk drive partitions (from B</proc/partitions>)
  43 and it will add/remove appropriate file-system type B<captive-ntfs> entries
  44 in B</etc/fstab>.
  45
  46 Destination directory is chosen automatically as B</mnt/@PACKAGE@->LABEL_NAME
  47 where B<LABEL_NAME> is the label used for the B<NTFS> partition. Directory
  48 B</mnt/@PACKAGE@-> may be used if no volume label is set. Different (numbered)
  49 directory name is used if multiple disks have the same volume label set.
  50
  51
  52 =head1 OPTIONS
  53
  54 =over
  55
  56 =item B<-v>|B<--verbose>
  57
  58 Display additional information during disks scanning.
  59
  60
  61 =item B<-n>|B<--dry>
  62
  63 Perform all the operations but do not modify anything (file B</etc/fstab>).
  64 You will probably use this option together with [B<-v>|B<--verbose>].
  65
  66
  67 =item B<--add>
  68
  69 Add all the found B<NTFS> disk drive partitions to B</etc/fstab>.
  70 Any previous B<captive-ntfs> entries will be deleted as described in
  71 B<--remove> option.
  72
  73
  74 =item B<--remove>
  75
  76 Remove all lines of filesystem type B<@PACKAGE@-ntfs> and device name in
  77 B</dev> directory.
  78
  79
  80 =back
  81
  82
  83 =head1 SEE ALSO
  84
  85 B<@PACKAGE@-install-acquire>(1), B<@PACKAGE@>(7), B<mount.@PACKAGE@>(8)
  86
  87
  88 =head1 AUTHOR
  89
  90 Jan Kratochvil <B<project-@PACKAGE@@jankratochvil.net>>,
  91                 I<http://www.jankratochvil.net/>
  92 POD_EOF
  93 1;