SEP Home About SEP People Research Courses Software Internal Info SEP WWW SEP Computing linux CEES-SEP Back-ups NODE CLONING CLUSTER BUILDING NODE UPGRADING Comp. Environ. Configuring Mail Computer Maint. Makefiles Mathematica FAQ Matlab FAQ Other info New Accounts Cluster node allocation Using pod Printing Python Task Force UNIX Setup

What is pod?

For additional information on pod, type "man perlpod" at the command line.

Using pod

In C:

/*$      -----> this starts the documentation

=head1 NAME  -----> starts a section

puff

=head1 SYNOPSIS

puff par= < in.H > out.H

=head1 PARAMETERS

=over 4      -----> this starts a list 

=item sea

      location parameter

=back        -----> this ends the list

=cut         -----> this ends the documentation

In F90:

!!$      -----> starts doc

!!$

!!$=head1 NAME

!!$

!!$magic

!!$

!!$=head1 DESCRIPTION

!!$

!!$frolicks in mist 

!!$

!!$=cut

In Ratfor90, perl, CSH:

#$       -----> starts doc

#$

#$=head1 NAME

#$

#$dragon

#$

#$=head1 DESCRIPTION

#$

#$=head2 Old English  -----> starts a subsection

#$

#$big, bad, miserly

#$

#$=head2 American

#$

#$friendly, playful

#$

#$=cut

How to see the pages

The text pages come up by just typing the program name on the command line. The tex pages can be created as any Latex document is created. The man pages come up with the standard man command. We are currently finding a place to put the html pages. The info pages will soon be working.

Department of Geophysics Stanford University

Modified: 10/25/07, 15:05:10 PDT , by bill
Page Maintainer: webmaster `AT' sep.stanford.edu

---