Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

Scripts on CPAN

by BooK (Curate)
on Nov 06, 2003 at 07:50 UTC ( #304981=perlquestion: print w/ replies, xml ) Need Help??
BooK has asked for the wisdom of the Perl Monks concerning the following question:

Is there any customary way to put scripts on CPAN? I've already put my script connect-tunnel on CPAN, just like a module distribution, but I wonder if that's the standard way to do it.

Comment on Scripts on CPAN
Re: Scripts on CPAN
by PodMaster (Abbot) on Nov 06, 2003 at 08:02 UTC
    How do I contribute scripts to CPAN? says
    CPAN has a scripts repository at http://www.cpan.org/scripts/ and http://www.cpan.org/scripts/submitting.html will instruct you on how to go about contributing your scripts.
    and http://www.cpan.org/scripts/submitting.html says

    How to submit a script to CPAN

    1. Get a PAUSE ID; this is required to upload files to CPAN.
    2. Create your script:
      • It must be a single file, not compressed or archived. This constraint will be relaxed in the future.
      • Insert the appropriate POD sections, as outlined below. (If you don't know what POD is, consult the `perlpod' manpage). There is one mandatory section, and several useful-but-optional sections.
      • The mandatory POD section is `SCRIPT CATEGORIES'. The existence of this section informs PAUSE that this is a script. The contents of this section indicate where the script should be presented in the categorized hierarchy; currently, you may specify up to three categories for your script.
      • The optional POD section `PREREQUISITES' contains a list of modules which this script requires in order to run.
      • The optional POD section `COREQUISITES' contains a list of modules which this script would benefit from having available, but which are not required.
      • The optional POD section `OSNAMES' contains a list of operating systems (as given in Perl's $^O variable) under which this script will run.
      • The contents of the optional POD section `README' will be automatically extracted and displayed.
    3. You may wish to check your script's format against the example script.
    4. Upload your script to PAUSE.
    5. New script categories are not automatically created. If you stipulate a SCRIPT CATEGORIES entry that does not exist, it will be silently ignored. New categories are created via discussion on the scripts mailing list. Please join the list before posting to it, by sending an empty email to scripts-subscribe@perl.org.

    Contents of POD sections

    The data in the POD sections, outlined above, must be presented in a machine-readable format. There are two ways to present the data:
    1. Unadorned, one item per line.
    2. Embedded in descriptive text, with the data appearing between C< and >.
    The example script contains COREQUISITES, OSNAMES, and SCRIPT CATEGORIES sections in the first format, and a PREREQUISITES section in the second format.

    Improving the process

    The scripts repository is still being refined. Please report and problems or suggestions to Kurt Starsinic.
    Last modified: Fri May 10 01:32:56 CEST 2002

    MJD says "you can't just make shit up and expect the computer to know what you mean, retardo!"
    I run a Win32 PPM repository for perl 5.6.x and 5.8.x -- I take requests (README).
    ** The third rule of perl club is a statement of fact: pod is sexy.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: perlquestion [id://304981]
Approved by EvdB
Front-paged by gmax
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others imbibing at the Monastery: (11)
As of 2014-09-22 11:34 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    How do you remember the number of days in each month?











    Results (189 votes), past polls