pod documents and shells?

Discussion in 'Perl Misc' started by Mike, Jan 20, 2005.

  1. Mike

    Mike Guest

    Is there a way to document shells (sh, ksh, csh, etc.) using pod?
     
    Mike, Jan 20, 2005
    #1
    1. Advertising

  2. Mike

    Guest

    Mike wrote:
    > 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
     
    , Jan 20, 2005
    #2
    1. Advertising

  3. Mike

    Mike Guest

    In article <lPUHd.1068$>, Mike wrote:
    > 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
     
    Mike, Jan 20, 2005
    #3
    1. Advertising

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

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Ajax Chelsea

    Is array of POD still a POD type?

    Ajax Chelsea, Dec 1, 2003, in forum: C++
    Replies:
    1
    Views:
    362
    Ron Natalie
    Dec 1, 2003
  2. dmh2000
    Replies:
    13
    Views:
    531
    Nick Craig-Wood
    Apr 10, 2006
  3. Ross Boylan

    question about subprocess and shells

    Ross Boylan, Dec 4, 2009, in forum: Python
    Replies:
    3
    Views:
    326
    Nobody
    Dec 5, 2009
  4. Robert Jones

    irb and unix shells

    Robert Jones, Dec 2, 2007, in forum: Ruby
    Replies:
    35
    Views:
    432
    Eero Saynatkari
    Dec 6, 2007
  5. Himanshu Garg
    Replies:
    1
    Views:
    176
    Himanshu Garg
    Sep 21, 2003
Loading...

Share This Page