Document the new options: --modid-path, --load-untested

[captive.git] / src / libcaptive / client / options.pod.pl.in

diff --git a/src/libcaptive/client/options.pod.pl.in b/src/libcaptive/client/options.pod.pl.in
index a7e62bb..260b551 100644 (file)
--- a/src/libcaptive/client/options.pod.pl.in
+++ b/src/libcaptive/client/options.pod.pl.in
@@ -27,16 +27,23 @@ use warnings;
 my $vardir='@localstatedir@/lib/@PACKAGE@';
 $vardir=~s#\$\Q{prefix}\E#'@prefix@';#ge;
 $vardir="/var/lib/@PACKAGE@" if $vardir=~/^@/;
+my $sysconfdir='@sysconfdir@';
+$sysconfdir=~s#\$\Q{prefix}\E#'@prefix@';#ge;
+$sysconfdir="/etc" if $sysconfdir=~/^@/;
 my $sbindir='@sbindir@';
 $sbindir=~s#\$\Q{exec_prefix}\E#'@exec_prefix@';#ge;
 $sbindir=~s#\$\Q{prefix}\E#'@prefix@';#ge;
 $sbindir="/usr/sbin" if $sbindir=~/^@/;
 
-print <<'POD_EOF';
+our $no_libcaptive_options_heading;
+print <<'POD_EOF' if !$no_libcaptive_options_heading;
 =head1 OPTIONS
 
 All programs using B<@PACKAGE@>(7) library share the common set of configuration
 options:
+POD_EOF
+
+print <<'POD_EOF';
 
 =over
 
@@ -60,6 +67,26 @@ print <<'POD_EOF';
 here.
 
 
+=item B<--modid-path>=B<pathname>
+
+Pathname to the B<.captivemodid.xml> database of existing W32 module
+identifications. The default used one is:
+POD_EOF
+print "B<$sysconfdir/w32-mod-id.captivemodid.xml>\n";
+print <<'POD_EOF';
+You must have this database update for any W32 binary module you are using.
+If you miss such database you may also try to use B<--load-untested> below.
+
+
+=item B<--load-untested>
+
+Load tthe W32 modules despite they may not match the current B<--modid-path>
+identifications database. If you use this option Captive may fail very easily
+as such module was never tested before the release and may need some
+compatibility updates. Still no data should be corrupted even if using this
+B<--load-untested> option.
+
+
 =item B<--ro>
 
 Read/write mode: Any write access will be forbidden. You should set this mode
@@ -123,6 +150,10 @@ B<chroot>(2), B<setuid>(2), B<setgid>(2) and B<setrlimit>(2) UNIX security
 features against malicious Microsoft Windows drivers. You should never use this
 option during debugging.
 
+This option is turned on automatically during the mount operation by
+B<mount.@PACKAGE@-ntfs>(8).
+Option needs to be used by hand for the B<captive-cmdline>(2) client.
+
 
 =item B<--sandbox-server-ior>=B<IOR>