diff options
| -rwxr-xr-x | bin/pkg | 2 | ||||
| -rw-r--r-- | man/1/pkg.pod (renamed from man/1/pkg) | 6 | ||||
| -rw-r--r-- | man/5/pkg.conf.pod (renamed from man/5/pkg.conf) | 6 | ||||
| -rw-r--r-- | man/7/pkg-setup.pod (renamed from man/7/pkg-setup) | 6 | ||||
| -rw-r--r-- | man/7/pkg.pod (renamed from man/7/pkg) | 15 |
5 files changed, 7 insertions, 28 deletions
@@ -558,7 +558,7 @@ function populate_collected { section=${man:h:t} manpage=${man:t} if podchecker man/$section/$manpage &> /dev/null; then - pod2man -u -s $section -c "$1 package" -r $HOME man/$section/$manpage > $PKG_DIR/.collected/man/man$section/$manpage.$section + pod2man -u -s $section -c "$1 package" -r $HOME man/$section/$manpage > $PKG_DIR/.collected/man/man$section/${manpage%.pod}.$section fi } for file in bin/*(N); { diff --git a/man/1/pkg b/man/1/pkg.pod index 830fd3e..7f207ba 100644 --- a/man/1/pkg +++ b/man/1/pkg.pod @@ -1,5 +1,3 @@ -=pod - =head1 NAME pkg - distributed dotfile and script manager @@ -162,7 +160,3 @@ many ideas and suggestions =head1 SEE ALSO L<pkg.conf>(5), pkg(7) - -=cut - -vim:ft=pod diff --git a/man/5/pkg.conf b/man/5/pkg.conf.pod index 9bb918a..d690c4f 100644 --- a/man/5/pkg.conf +++ b/man/5/pkg.conf.pod @@ -1,5 +1,3 @@ -=pod - =head1 NAME ~/.pkg.conf - L<pkg>(1) configuration @@ -108,7 +106,3 @@ Colour for warning and error messages (default: red) =head1 SEE ALSO L<pkg>(1), L<checklinks>(1) - -=cut - -vim:ft=pod diff --git a/man/7/pkg-setup b/man/7/pkg-setup.pod index a6438a1..1c0d7bf 100644 --- a/man/7/pkg-setup +++ b/man/7/pkg-setup.pod @@ -1,5 +1,3 @@ -=pod - =head1 NAME pkg - Package root setup @@ -17,7 +15,3 @@ Now you can add your own packages as git repos in PKG_ROOT. To use pkg with your packages on a machine, download and execute the bootstrap script (include/bootstrap). - -=cut - -vim:ft=pod diff --git a/man/7/pkg b/man/7/pkg.pod index a6d41b2..c9163d7 100644 --- a/man/7/pkg +++ b/man/7/pkg.pod @@ -1,5 +1,3 @@ -=pod - =head1 NAME pkg - distributed dotfile and script manager, package format @@ -83,7 +81,8 @@ Unless marked with [*], all files and directories are optional The place for executables to be in the user's PATH. pkg will automatically create symlinks in F<~/bin> pointing to the files -in the package's F<bin/> +in the package's F<bin/>. Also, if a file in F<bin/> contains valid POD, +a manual will be generated out of it (see L</"COLLECTED PACKAGE FILES">) =item etc/ @@ -99,7 +98,9 @@ Scripts used by the package that don't belong into B<bin/>. Not threated special =item man/ -Manual files in POD format, separated by section (like man/7/pkg) +Manual files in POD format, separated by section (like man/7/pkg.pod). +To be prepared for possible future support of other manual formats, it is +recommended to postfix each file with .pod =item provides/ @@ -215,7 +216,7 @@ The directory is somewhat similar to F<~/bin> - it is automatically populated by pkg. However, this one does not contain symlinks. Currently, it only contains the directory F<man/>, which holds the "compiled" -manual pages from the packages (both extracted from F<bin/> and F<man/>). +manual pages from the packages (extracted from F<bin/> and F<man/>). This way, yuo can put F<.../.collected/man> into you MANPATH to access manuals provided by packages. @@ -233,7 +234,3 @@ Daniel Friesel E<lt>derf@derf.homelinux.orgE<gt> =head1 SEE ALSO checklinks(1), pkg(1) - -=cut - -vim:ft=pod |