if ( -f ) {
push @list, $_
} elsif ( -d ) {
- push @list, all_pod_files( $_ )
+ push @list, grep { !m,fragments/, } all_pod_files( $_ )
}
}
--- /dev/null
+#!/usr/bin/perl -w
+#
+# POD currently doesn't support any sort of =include directive. This
+# processor works around that limitation. It takes a list of files ending in
+# *.in as its argument and processes any POD directives of the form =include
+# <file> in that file, generating a file with the *.in suffix removed. All
+# paths are taken to be relative to the directory containing the file being
+# processed.
+#
+# Currently, only single include nesting is supported. The included file is
+# not processed for additional =include statements.
+
+require 5.006;
+
+use Cwd qw(getcwd);
+use File::Basename qw(dirname basename);
+
+my $start = getcwd;
+for my $file (@ARGV) {
+ chdir $start or die "cannot chdir to $start: $!\n";
+ my $dir = dirname ($file);
+ my $out = $file;
+ unless ($out =~ s/\.in\z//) {
+ die "input file $file does not end in .in\n";
+ }
+ open (FILE, '<', $file) or die "cannot open $file: $!\n";
+ open (OUT, '>', $out) or die "cannot open $out: $!\n";
+ chdir $dir or die "cannot chdir to $dir: $!\n";
+ local $/ = '';
+ local $_;
+ while (<FILE>) {
+ if (/^=include\s+(\S+)/) {
+ open (INCLUDE, '<', $1) or die "cannot open $1: $!\n";
+ local $/;
+ print OUT <INCLUDE> or die "cannot read/write from $1: $!\n";
+ close INCLUDE or die "cannot read from $1: $!\n";
+ print OUT "\n" or die "cannot write to $out: $!\n";
+ } else {
+ print OUT $_ or die "cannot write to $out: $!\n";
+ }
+ }
+ close OUT or die "cannot write to $out: $!\n";
+ close FILE or die "cannot read from $file\n";
+}
--- /dev/null
+# After changing this file, please run
+# git ls-files -i --exclude-standard
+# to check that you haven't inadvertently ignored any tracked files.
+
+/pts_adduser.pod
+/pts_chown.pod
+/pts_creategroup.pod
+/pts_createuser.pod
+/pts_delete.pod
+/pts_examine.pod
+/pts_interactive.pod
+/pts_listentries.pod
+/pts_listmax.pod
+/pts_listowned.pod
+/pts_membership.pod
+/pts_quit.pod
+/pts_removeuser.pod
+/pts_rename.pod
+/pts_setfields.pod
+/pts_setmax.pod
+/pts_sleep.pod
+/pts_source.pod
--- /dev/null
+=item B<-cell> <I<cell name>>
+
+Names the cell in which to run the command. For more details, see
+L<pts(1)>.
+
+=item B<-force>
+
+Enables the command to continue executing as far as possible when errors
+or other problems occur, rather than halting execution at the first error.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=item B<-localauth>
+
+Constructs a server ticket using a key from the local
+F</usr/afs/etc/KeyFile> file. Do not combine this flag with the B<-cell>
+or B<-noauth> options. For more details, see L<pts(1)>.
+
+=item B<-noauth>
+
+Assigns the unprivileged identity anonymous to the issuer. For more
+details, see L<pts(1)>.
each group to which to add members. The group entry must already exist in
the Protection Database.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. The B<pts> command interpreter presents the
-ticket to the Protection Server during mutual authentication. Do not combine
-this flag with the B<-cell> or B<-noauth> options. For more details, see
-L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
Names the user or group to become the group's owner.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the B<-cell>
-or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
the GIDs is lower (more negative) than the current value of the C<max
group id> counter, the counter is reset to that value.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
ignored. If any of the UIDs is greater than the current value of the C<max
user id> counter, the counter is reset to that value.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
machines) and IDs. Precede the GID of each group with a hyphen to indicate
that it is negative.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
well as names (IP addresses for machines) and IDs. Precede the GID of each
group with a hyphen to indicate that it is negative.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
=item B<-auth>
Run using the user's current authentication. This is the default unless
the B<-noauth> or B<-localauth> options are used.
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
=over 4
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-This is useful for bulk operations where you would like to continue even
-if one of many operations fails.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
+=include fragments/pts-common.pod
=back
Displays group entries.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
=over 4
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
A value of 0 (zero) lists group entries for groups whose owners no longer
have entries in the Protection Database.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
Group membership may be nested when B<ptserver> is compilied with the
SUPERGROUPS option enabled.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
=over 4
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
+=include fragments/pts-common.pod
=back
Names each group from which to remove members.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
field (the part before the colon) of the new name must reflect the actual
ownership of the group.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
matter how many he or she has created already). Do not include this
argument for a group or machine entry.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
that command's B<-id> argument, the Protection Server assigns the group an
AFS UID one greater than this value.
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/pts-common.pod
=back
=over 4
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
+=include fragments/pts-common.pod
=back
=over 4
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. For more details, see
-L<pts(1)>.
-
-=item B<-file> <I<file name>>
-
-Specifies the filename from which to read commands.
-
-=item B<-force>
-
-Enables the command to continue executing as far as possible when errors
-or other problems occur, rather than halting execution at the first error.
-This is useful for bulk operations where you would like to continue even
-if one of many operations fails.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. For more
-details, see L<pts(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
-B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
+=include fragments/pts-common.pod
=back
# pod2man available.
if test -d doc/man-pages ; then
echo "Building man pages"
+ perl doc/man-pages/merge-pod doc/man-pages/pod1/*.in
(cd doc/man-pages && ./generate-man)
fi
fi
git://git.openafs.org / openafs.git / commitdiff