pod documents and shells?

J

jl_post

Mike said:
Is there a way to document shells (sh, ksh, csh, etc.) using pod?


Sure.

Just save the following (without the "|") in a file called "ksh.pod":


|=head1 NAME
|
|ksh - a shell
|
|=head1 SYNOPSIS
|
| ksh
|
|=head1 DESCRIPTION
|
|Description goes here.
|
|=cut


Then you can type "perldoc ksh" to see the documentation, or "pod2html
ksh > ksh.html" to create an HTML file.
Hope this helps,

-- Jean-Luc
 
M

Mike

Is there a way to document shells (sh, ksh, csh, etc.) using pod?

This is a 'duh' moment.

#!/bin/sh

cp this that

....

exit 0

=pod

=head1 NAME

someshell.sh

=cut
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Similar Threads

Pod links to manpages 0
confused about POD 8
using print<<`EOC` 3
here documents 0
pod question 1
Detecting Bourne (or csh) shell from Perl 8
POD documentation 1
detecting pod in a file? 8

Members online

No members online now.

Forum statistics

Threads
473,743
Messages
2,569,478
Members
44,899
Latest member
RodneyMcAu

Latest Threads

Top