src/client/lufs/mount.captive.pod.pl.in

   1 #! /usr/bin/perl
   2 #
   3 # $Id$
   4 # perlpod(1) source for captive(7) 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 mount.@PACKAGE@ - B<mount>(8) interface for NTFS disk access
  31
  32
  33 =head1 SYNOPSIS
  34
  35 B<mount.@PACKAGE@-ntfs> {B<image-file>|B<device>} B<mountdir>
  36 [B<-n>] [B<-v>] [B<-o> B<options>]
  37
  38 B<mount> B<-t> B<@PACKAGE@-ntfs>
  39 [B<-n>] [B<-v>] [B<-o> B<options>]
  40 {B<image-file>|B<device>} B<dir>
  41
  42
  43 =head1 DESCRIPTION
  44
  45 B<mount.@PACKAGE@>(8) provides B<mount>(8) interface to B<lufs-@PACKAGE@fs>(7)
  46 by calling B<lufsd>(1) with appropriate arguments. You should never call
  47 this command directly - use B<mount>(8) instead.
  48
  49 B<mount.@PACKAGE@>(8) (B<@PACKAGE@> filesystem type) is never used - this command
  50 is provided just as a base mount(8) interface to B<@PACKAGE@>(7). You must always
  51 use @PACKAGE@-B<fstype> filesystem type such as B<@PACKAGE@-ntfs>. Other supported
  52 filesystem types are:
  53 POD_EOF
  54 print join ", ",map("B<$_>",(split /:/,'@enable_sbin_mount_fs@'));
  55 print <<'POD_EOF';
  56
  57
  58 =head1 OPTIONS
  59
  60 =over
  61
  62 =item {B<image-file>|B<device>}
  63
  64 Pathname such as B</dev/hda1> or B</tmp/ntfs.bin>. You should refer to the
  65 partition name, not the whole device (B</dev/hda> is forbidden).
  66 B</dev/hda1> may correspond to B</dev/ide/host0/bus0/target0/lun0/part1>
  67 on your system.
  68
  69
  70 =item B<mountdir>
  71
  72 Existing empty target directory where {B<image-file>|B<device>} will be
  73 mounted.
  74
  75
  76 =item B<-n>
  77
  78 Do not modify B</etc/mtab>. This option is currently not supported (ignored),
  79 B</etc/mtab> is modified notwithstanding.
  80
  81
  82 =item B<-v>
  83
  84 Enable verbose mode. Command B<lufsd>(1) being called is shown.
  85
  86
  87 =item B<-o> B<options>
  88
  89 Custom options passed to B<@PACKAGE@>(7) separated by comma (B<,>).
  90 See the B<@PACKAGE@>(7) manpage for details on options prefixed by
  91 double-dashes (B<-->) will be used for B<lufs-@PACKAGE@fs>(7) /
  92 B<mount.captive>(8). Options without double-dashes (B<-->) will be used for
  93 B<lufsd>(1). You may be interested in these unprefixed options:
  94
  95 =over
  96
  97 =item B<force>
  98
  99 Force the mount of {B<image-file>|B<device>} despite it appears to be already
 100 mounted according to B<mtab>(5). You should never mount a device multiple
 101 times in read-write mode. It is safe to mount it multiple times in read-only
 102 mode. It is safe to mount it once in read-write mode and multiple times
 103 in read-only mode although you may encounter filesystem errors by the read-only
 104 filesystems in such case.
 105
 106 This is the only option is interpreted by B<mount.@PACKAGE@> itself; it is not
 107 B<lufs-@PACKAGE@fs>(7) nor B<lufsd>(1) option.
 108
 109 =item B<private>
 110
 111 B<mount.captive>(8) defaults to filesystem files B<644> - read-write for system
 112 root (or the regular user owner) and read-only for others. You can force the
 113 mode B<600> by this option (read-write for the owner, inaccessible for others).
 114 Mode B<755> or <700> applies to directories. Options B<fmask>/B<dmask> will
 115 be OR-ed to the private/public permissions set by this option.
 116
 117 =item B<fmask>=B<666>
 118
 119 Octal mask to be OR-ed on file permissions (minimum file permissions).
 120
 121 =item B<dmask>=B<777>
 122
 123 Octal mask to be OR-ed on directory permissions (minimum directory
 124 permissions).
 125
 126 =item B<uid>=B<500>
 127
 128 Supply the B<UID> to be the user identification number owning all the files.
 129
 130 =item B<gid>=B<500>
 131
 132 Supply the B<GID> to be the group identification number owning all the files.
 133
 134 =back
 135
 136 =back
 137
 138
 139 =head1 SEE ALSO
 140
 141 B<lufs-@PACKAGE@fs>(7), B<lufsd>(1)
 142
 143
 144 =head1 AUTHOR
 145
 146 Jan Kratochvil <B<project-@PACKAGE@@jankratochvil.net>>,
 147                 I<http://www.jankratochvil.net/>
 148 POD_EOF
 149 1;