diff options
| author | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-07 13:10:07 +0200 |
|---|---|---|
| committer | Daniel Friesel <derf@derf.homelinux.org> | 2009-07-07 13:10:07 +0200 |
| commit | bed8857b779b9896f6a3b54336feddb41c0a5b5a (patch) | |
| tree | 2fc8a1708042a9e5db52af80b1fc7c455a77bc0c /man/7 | |
| parent | b37e001d893f8cd1b2efed154095f47593643b04 (diff) | |
pkg: Recommend to postfix manuals in man/ with .pod
Diffstat (limited to 'man/7')
| -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 |
2 files changed, 6 insertions, 15 deletions
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 |