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

   1 #! /usr/bin/perl
   2 #
   3 # $Id$
   4 # perlpod(1) source for captive-install-acquire(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 my $vardir='@localstatedir@/lib/@PACKAGE@';
  28 $vardir=~s#\$\Q{prefix}\E#'@prefix@';#ge;
  29 $vardir="/var/lib/@PACKAGE@" if $vardir=~/^@/;
  30 my $sysconfdir='@sysconfdir@';
  31 $sysconfdir=~s#\$\Q{prefix}\E#'@prefix@';#ge;
  32 $sysconfdir="/etc" if $sysconfdir=~/^@/;
  33
  34 print <<'POD_EOF';
  35 =head1 NAME
  36
  37 @PACKAGE@-install-acquire - Find MS Windows XP driver files for B<NTFS>
  38
  39
  40 =head1 SYNOPSIS
  41
  42 =for man
  43 \fB@PACKAGE@-install-acquire\fP [\fB--text]
  44 [\fB-v\fP|\fB--verbose\fP] [\fB-n\fP|\fB--dry\fP]
  45 .br
  46                 [\fB--modid-path\fP=\fBpath\fP] [\fB--scan-disks\fP] [\fB--scan-disks-quick\fP]
  47 .br
  48                 [\fB--scan-path\fP=\fBpath/URI\fP] [\fB--microsoft-com\fP]
  49
  50
  51 =head1 DESCRIPTION
  52
  53 Program acquires the needed I<Microsoft Windows XP> driver files. Multiple
  54 methods of getting the driver files are supported. All the driver files are
  55 stored to the directory
  56 POD_EOF
  57 print "B<$vardir/>\n";
  58 print <<'POD_EOF';
  59 where they are
  60 expected by B<mount.@PACKAGE@>(8).
  61
  62
  63 =head1 OPTIONS
  64
  65 Program will run interactively if no action options (B<--scan-disks>,
  66 B<--scan-disks-quick>, B<--scan-path> or B<--microsoft-com>) are specified.
  67 Otherwise the requested action(s) is proceeded in silent batch mode.
  68
  69 =over
  70
  71 =item B<--text>
  72
  73 Disable I<Gnome> user interface even if I<X Window System> is available.
  74 You must specify this option as the first one. This option has effect only for
  75 interactive mode (no action options specified).
  76
  77
  78 =item B<-v>|B<--verbose>
  79
  80 Display additional information during disks scanning.
  81
  82
  83 =item B<-n>|B<--dry>
  84
  85 Perform all the operations but do not modify anything (no drivers are
  86 stored to
  87 POD_EOF
  88 print "B<$vardir/>\n";
  89 print <<'POD_EOF';
  90 directory).
  91
  92
  93 =item B<--modid-path>=B<path>
  94
  95 Path to B<.captivemodid.xml> database (default:
  96 POD_EOF
  97 print "B<$sysconfdir/w32-mod-id.captivemodid.xml>";
  98 print <<'POD_EOF';
  99 ). This file contains
 100 identifications (B<md5sum>(1)) of known compatible I<Microsoft Windows XP>
 101 driver files. B<@PACKAGE@-install-acquire>(1) will ignore any files not
 102 identified by this file although you may try to copy them to
 103 POD_EOF
 104 print "B<$vardir/>\n";
 105 print <<'POD_EOF';
 106 manually for B<@PACKAGE@>(7) clients.
 107
 108
 109 =item B<--scan-disks>
 110
 111 Scan all files on any local hard drive (mounted or unmounted) B<NTFS> or
 112 (mounted) B<FAT> partitions. This scanning includes I<cabinet> (B<.cab>)
 113 archives. This scanning can last for very long time.
 114
 115
 116 =item B<--scan-disks-quick>
 117
 118 Reduced version of B<--scan-disks>. Only B<windows/system32> subdirectory in
 119 the root of any local hard drive (mounted or unmounted) B<NTFS> or (mounted)
 120 B<FAT> partition is investigated. This scan should find existing driver files
 121 in already existing I<Microsoft Windows XP> installations.
 122
 123
 124 =item B<--scan-path>=B<path/URI>
 125
 126 Scan the specified B<path/URI> for device driver files. You may use either
 127 filename (B</tmp/ntoskrnl.ex_>), directory (B</tmp/servicepack.cab>), B<NTFS>
 128 disk file/directory (B<file:///dev/hda1#libntfs:/windows/system32>) or remote
 129 I<URI> filename (B<http://server/path/to/ntfs.sys>). Remote I<URI> directory
 130 (such as B<http://server/subdir/>) is not supported.
 131
 132 Possibly specified directory is always scanned recursively.
 133
 134
 135 =item B<--microsoft-com>
 136
 137 You can download the best available version of needed drivers from
 138 I<Microsoft>.  They can be found in I<Microsoft Windows XP Service Pack 2
 139 Checked Build> (URL
 140 B<http://msdn.microsoft.com/security/productinfo/xpsp2>)
 141
 142 Legal: In some countries you need to have valid I<Microsoft Windows XP> license
 143 to use it.
 144
 145 Program will need to download approx 61MB of data (the cabinet file is 307MB;
 146 1MB=1e6B here).
 147
 148
 149 =back
 150
 151
 152 =head1 SEE ALSO
 153
 154 B<@PACKAGE@-install-fstab>(1), B<@PACKAGE@>(7), B<lufs-@PACKAGE@fs>(7)
 155
 156
 157 =head1 AUTHOR
 158
 159 Jan Kratochvil <B<project-@PACKAGE@@jankratochvil.net>>,
 160                 I<http://www.jankratochvil.net/>
 161 POD_EOF
 162 1;