MINICPAN(1p)

📦
version 1.111017 · 3 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 MINICPAN 💖

okay bestie, so this is a page from the User Contributed Perl Documentation section of the manual (the 1p girlies know), and it's all about minicpan — the lil script that uses CPAN::Mini to create or update a local mirror. yes. a mini CPAN. your own personal CPAN. in your house. obsessed. 🏠✨

✨ NAME ✨

minicpan — uses CPAN::Mini to create or update a local mirror. that's it. that's the whole job. 💅

🌸 VERSION 🌸

version 1.111017 — she's got a number and she's proud of it 🎀

🦋 SYNOPSIS 🦋

the vibe is: you run her, you give her options, she mirrors.

minicpan [options]

Options
  -l LOCAL    - where is the local minicpan?     (required)
  -r REMOTE   - where is the remote cpan mirror? (required)
  -d 0###     - permissions (numeric) to use when creating directories
  -f          - check all directories, even if indices are unchanged
  -p          - mirror perl, ponie, and parrot distributions
  --debug     - run in debug mode (print even banal messages)
  -q          - run in quiet mode (don't print status)
  -qq         - run in silent mode (don't even print warnings)
  -c CLASS    - what class to use to mirror (default: CPAN::Mini)
  -C FILE     - what config file to use (default: ~/.minicpanrc)
  -h          - print help and exit
  -v          - print version and exit
  -x          - build an exact mirror, getting even normally disallowed files
  -t SEC      - timeout in sec. Defaults to 180 sec
  --offline   - operate in offline mode (generally: do nothing)
  --log-level - provide a log level; instead of --debug, -q, or -qq
  --remote-from TYPE - cpan remote from 'cpan' or 'cpanplus' configs

like look at her go. so many little flags. so many lil choices. 🫶

🌈 DESCRIPTION 🌈

so this simple shell script literally just updates (or creates, if she doesn't exist yet) a miniature CPAN mirror, exactly the way CPAN::Mini describes it. that's the entire plot. no twists. 🔥

💜 PERL VERSION 💜

ngl this library should run on perls released even a long time ago. she should work on any version of perl released in the last five years. periodt.

but listen — although it may work on older versions of perl, there is no guarantee that the minimum required version won't get bumped up later. the version may be increased for any reason, and there's no promise that patches will be accepted to lower the minimum required perl. so don't come for her. 💀

🎀 CONFIGURATION FILE 🎀

by default, minicpan will read a configuration file to get her configuration info. the file is just a simple set of names and values, like this lil cutie:

local:  /home/rjbs/mirrors/minicpan/
remote: http://your.favorite.cpan/cpan/
exact_mirror: 1

and here's how minicpan goes hunting for that config file — she takes the first defined one she finds:

  • Use the value specified by -C on the command line
  • Use the value in the CPAN_MINI_CONFIG environment variable
  • Use ~/.minicpanrc
  • Use CPAN/Mini/minicpan.conf
⚠️ important bestie: if the selected file does not exist, minicpan does not keep looking. she stops. she's committed. no backup plan, no second choice. 💅

you can override this whole process with a config_file method in your subclass, if you're feeling main character energy. 👑

see CPAN::Mini for a full listing of available options. (yes, all of them. go look. iykyk.)

💀 TO DO 💀

  • Improve command-line options.

(she said "improve command-line options" and honestly? valid. we love a self-aware icon.) 🙈

⭐ SEE ALSO ⭐

Randal Schwartz's original article, which can be found here:

http://www.stonehenge.com/merlyn/LinuxMag/col42.html

go read the origin story fr fr 📖✨

👑 AUTHORS 👑

  • Ricardo SIGNES <cpan@semiotic.systems>
  • Randal Schwartz <merlyn@stonehenge.com>

two legends. no cap. 🫶

This software is copyright (c) 2004 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

slay, free software, we love to see it 💖

okay and that's the whole page!! mwah 💋 this was MINICPAN(1p) from the User Contributed Perl Documentation, generated by perl v5.36.0, dated 2023-10-01. take care of her, she's iconic 🌈🎀✨

📦 where this page comes from