{
    "content": [
        {
            "type": "text",
            "text": "# CPAN::FirstTime (perldoc)\n\n## NAME\n\nCPAN::FirstTime - Utility for CPAN::Config file Initialization\n\n## SYNOPSIS\n\nCPAN::FirstTime::init()\n\n## DESCRIPTION\n\nThe init routine asks a few questions and writes a CPAN/Config.pm or CPAN/MyConfig.pm file\n(depending on what it is currently using).\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "CPAN::FirstTime",
        "section": "",
        "mode": "perldoc",
        "summary": "CPAN::FirstTime - Utility for CPAN::Config file Initialization",
        "synopsis": "CPAN::FirstTime::init()",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 508,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "CPAN::FirstTime - Utility for CPAN::Config file Initialization\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "CPAN::FirstTime::init()\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The init routine asks a few questions and writes a CPAN/Config.pm or CPAN/MyConfig.pm file\n(depending on what it is currently using).\n\nIn the following all questions and explanations regarding config variables are collected.\n\nallowinstallingmoduledowngrades\nThe CPAN shell can watch the \"blib/\" directories that are built up before running \"make test\"\nto determine whether the current distribution will end up with modules being overwritten with\ndecreasing module version numbers. It can then let the build of this distro fail when it\ndiscovers a downgrade.\n\nDo you want to allow installing distros with decreasing module versions compared to what you\nhave installed (yes, no, ask/yes, ask/no)?\n\nallowinstallingoutdateddists\nThe CPAN shell can watch the \"blib/\" directories that are built up before running \"make test\"\nto determine whether the current distribution contains modules that are indexed with a distro\nwith a higher distro-version number than the current one. It can then let the build of this\ndistro fail when it would not represent the most up-to-date version of the distro.\n\nNote: choosing anything but 'yes' for this option will need CPAN::DistnameInfo being installed\nfor taking effect.\n\nDo you want to allow installing distros that are not indexed as the highest distro-version for\nall contained modules (yes, no, ask/yes, ask/no)?\n\nautocommit\nNormally CPAN.pm keeps config variables in memory and changes need to be saved in a separate\n'o conf commit' command to make them permanent between sessions. If you set the 'autocommit'\noption to true, changes to a config variable are always automatically committed to disk.\n\nAlways commit changes to config variables to disk?\n\nbuildcache\nCPAN.pm can limit the size of the disk area for keeping the build directories with all the\nintermediate files.\n\nCache size for build directory (in MB)?\n\nbuilddir\nDirectory where the build process takes place?\n\nbuilddirreuse\nUntil version 1.88 CPAN.pm never trusted the contents of the builddir directory between\nsessions. Since 1.8858 CPAN.pm has a YAML-based mechanism that makes it possible to share the\ncontents of the builddir/ directory between different sessions with the same version of perl.\nPeople who prefer to test things several days before installing will like this feature because\nit saves a lot of time.\n\nIf you say yes to the following question, CPAN will try to store enough information about the\nbuild process so that it can pick up in future sessions at the same state of affairs as it\nleft a previous session.\n\nStore and re-use state information about distributions between CPAN.pm sessions?\n\nbuildrequiresinstallpolicy\nWhen a module declares another one as a 'buildrequires' prerequisite this means that the\nother module is only needed for building or testing the module but need not be installed\npermanently. In this case you may wish to install that other module nonetheless or just keep\nit in the 'builddir' directory to have it available only temporarily. Installing saves time\non future installations but makes the perl installation bigger.\n\nYou can choose if you want to always install (yes), never install (no) or be always asked. In\nthe latter case you can set the default answer for the question to yes (ask/yes) or no\n(ask/no).\n\nPolicy on installing 'buildrequires' modules (yes, no, ask/yes, ask/no)?\n\ncachemetadata\nTo considerably speed up the initial CPAN shell startup, it is possible to use Storable to\ncreate a cache of metadata. If Storable is not available, the normal index mechanism will be\nused.\n\nNote: this mechanism is not used when usesqlite is on and SQLLite is running.\n\nCache metadata (yes/no)?\n\nchecksigs\nCPAN packages can be digitally signed by authors and thus verified with the security provided\nby strong cryptography. The exact mechanism is defined in the Module::Signature module. While\nthis is generally considered a good thing, it is not always convenient to the end user to\ninstall modules that are signed incorrectly or where the key of the author is not available or\nwhere some prerequisite for Module::Signature has a bug and so on.\n\nWith the checksigs parameter you can turn signature checking on and off. The default is off\nfor now because the whole tool chain for the functionality is not yet considered mature by\nsome. The author of CPAN.pm would recommend setting it to true most of the time and turning it\noff only if it turns out to be annoying.\n\nNote that if you do not have Module::Signature installed, no signature checks will be\nperformed at all.\n\nAlways try to check and verify signatures if a SIGNATURE file is in the package and\nModule::Signature is installed (yes/no)?\n\ncleanupafterinstall\nUsers who install modules and do not intend to look back, can free occupied disk space quickly\nby letting CPAN.pm cleanup each build directory immediately after a successful install.\n\nRemove build directory after a successful install? (yes/no)?\n\ncolorizeoutput\nWhen you have Term::ANSIColor installed, you can turn on colorized output to have some visual\ndifferences between normal CPAN.pm output, warnings, debugging output, and the output of the\nmodules being installed. Set your favorite colors after some experimenting with the\nTerm::ANSIColor module.\n\nPlease note that on Windows platforms colorized output also requires the Win32::Console::ANSI\nmodule.\n\nDo you want to turn on colored output?\n\ncolorizeprint\nColor for normal output?\n\ncolorizewarn\nColor for warnings?\n\ncolorizedebug\nColor for debugging messages?\n\ncommandnumberinprompt\nThe prompt of the cpan shell can contain the current command number for easier tracking of the\nsession or be a plain string.\n\nDo you want the command number in the prompt (yes/no)?\n\nconnecttointernetok\nIf you have never defined your own \"urllist\" in your configuration then \"CPAN.pm\" will be\nhesitant to use the built in default sites for downloading. It will ask you once per session\nif a connection to the internet is OK and only if you say yes, it will try to connect. But to\navoid this question, you can choose your favorite download sites once and get away with it.\nOr, if you have no favorite download sites answer yes to the following question.\n\nIf no urllist has been chosen yet, would you prefer CPAN.pm to connect to the built-in default\nsites without asking? (yes/no)?\n\nftppassive\nShall we always set the FTPPASSIVE environment variable when dealing with ftp download\n(yes/no)?\n\nftpstatsperiod\nStatistics about downloads are truncated by size and period simultaneously.\n\nHow many days shall we keep statistics about downloads?\n\nftpstatssize\nStatistics about downloads are truncated by size and period simultaneously. Setting this to\nzero or negative disables download statistics.\n\nHow many items shall we keep in the statistics about downloads?\n\ngetcwd\nCPAN.pm changes the current working directory often and needs to determine its own current\nworking directory. Per default it uses Cwd::cwd but if this doesn't work on your system for\nsome reason, alternatives can be configured according to the following table:\n\ncwd         Cwd::cwd\ngetcwd      Cwd::getcwd\nfastcwd     Cwd::fastcwd\ngetdcwd     Cwd::getdcwd\nbacktickcwd external command cwd\n\nPreferred method for determining the current working directory?\n\nhaltonfailure\nNormally, CPAN.pm continues processing the full list of targets and dependencies, even if one\nof them fails. However, you can specify that CPAN should halt after the first failure. (Note\nthat optional recommended or suggested modules that fail will not cause a halt.)\n\nDo you want to halt on failure (yes/no)?\n\nhistfile\nIf you have one of the readline packages (Term::ReadLine::Perl, Term::ReadLine::Gnu, possibly\nothers) installed, the interactive CPAN shell will have history support. The next two\nquestions deal with the filename of the history file and with its size. If you do not want to\nset this variable, please hit SPACE ENTER to the following question.\n\nFile to save your history?\n\nhistsize\nNumber of lines to save?\n\ninactivitytimeout\nSometimes you may wish to leave the processes run by CPAN alone without caring about them.\nBecause the Makefile.PL or the Build.PL sometimes contains question you're expected to answer,\nyou can set a timer that will kill a 'perl Makefile.PL' process after the specified time in\nseconds.\n\nIf you set this value to 0, these processes will wait forever. This is the default and\nrecommended setting.\n\nTimeout for inactivity during {Makefile,Build}.PL?\n\nindexexpire\nThe CPAN indexes are usually rebuilt once or twice per hour, but the typical CPAN mirror\nmirrors only once or twice per day. Depending on the quality of your mirror and your desire to\nbe on the bleeding edge, you may want to set the following value to more or less than one day\n(which is the default). It determines after how many days CPAN.pm downloads new indexes.\n\nLet the index expire after how many days?\n\ninhibitstartupmessage\nWhen the CPAN shell is started it normally displays a greeting message that contains the\nrunning version and the status of readline support.\n\nDo you want to turn this message off?\n\nkeepsourcewhere\nUnless you are accessing the CPAN on your filesystem via a file: URL, CPAN.pm needs to keep\nthe source files it downloads somewhere. Please supply a directory where the downloaded files\nare to be kept.\n\nDownload target directory?\n\nloadmoduleverbosity\nWhen CPAN.pm loads a module it needs for some optional feature, it usually reports about\nmodule name and version. Choose 'v' to get this message, 'none' to suppress it.\n\nVerbosity level for loading modules (none or v)?\n\nmakeplarg\nEvery Makefile.PL is run by perl in a separate process. Likewise we run 'make' and 'make\ninstall' in separate processes. If you have any parameters (e.g. PREFIX, UNINST or the like)\nyou want to pass to the calls, please specify them here.\n\nIf you don't understand this question, just press ENTER.\n\nTypical frequently used settings:\n\nPREFIX=~/perl    # non-root users (please see manual for more hints)\n\nParameters for the 'perl Makefile.PL' command?\n\nmakearg\nParameters for the 'make' command? Typical frequently used setting:\n\n-j3              # dual processor system (on GNU make)\n\nYour choice:\n\nmakeinstallarg\nParameters for the 'make install' command? Typical frequently used setting:\n\nUNINST=1         # to always uninstall potentially conflicting files\n# (but do NOT use with local::lib or INSTALLBASE)\n\nYour choice:\n\nmakeinstallmakecommand\nDo you want to use a different make command for 'make install'? Cautious people will probably\nprefer:\n\nsu root -c make\nor\nsudo make\nor\n/path1/to/sudo -u adminaccount /path2/to/make\n\nor some such. Your choice:\n\nmbuildplarg\nA Build.PL is run by perl in a separate process. Likewise we run './Build' and './Build\ninstall' in separate processes. If you have any parameters you want to pass to the calls,\nplease specify them here.\n\nTypical frequently used settings:\n\n--installbase /home/xxx             # different installation directory\n\nParameters for the 'perl Build.PL' command?\n\nmbuildarg\nParameters for the './Build' command? Setting might be:\n\n--extralinkerflags -L/usr/foo/lib  # non-standard library location\n\nYour choice:\n\nmbuildinstallarg\nParameters for the './Build install' command? Typical frequently used setting:\n\n--uninst 1       # uninstall conflicting files\n# (but do NOT use with local::lib or INSTALLBASE)\n\nYour choice:\n\nmbuildinstallbuildcommand\nDo you want to use a different command for './Build install'? Sudo users will probably prefer:\n\nsu root -c ./Build\nor\nsudo ./Build\nor\n/path1/to/sudo -u adminaccount ./Build\n\nor some such. Your choice:\n\npager\nWhat is your favorite pager program?\n\npreferinstaller\nWhen you have Module::Build installed and a module comes with both a Makefile.PL and a\nBuild.PL, which shall have precedence?\n\nThe main two standard installer modules are the old and well established ExtUtils::MakeMaker\n(for short: EUMM) which uses the Makefile.PL. And the next generation installer Module::Build\n(MB) which works with the Build.PL (and often comes with a Makefile.PL too). If a module comes\nonly with one of the two we will use that one but if both are supplied then a decision must be\nmade between EUMM and MB. See also http://rt.cpan.org/Ticket/Display.html?id=29235 for a\ndiscussion about the right default.\n\nOr, as a third option you can choose RAND which will make a random decision (something regular\nCPAN testers will enjoy).\n\nIn case you can choose between running a Makefile.PL or a Build.PL, which installer would you\nprefer (EUMM or MB or RAND)?\n\nprefsdir\nCPAN.pm can store customized build environments based on regular expressions for distribution\nnames. These are YAML files where the default options for CPAN.pm and the environment can be\noverridden and dialog sequences can be stored that can later be executed by an Expect.pm\nobject. The CPAN.pm distribution comes with some prefab YAML files that cover sample\ndistributions that can be used as blueprints to store your own prefs. Please check out the\ndistroprefs/ directory of the CPAN.pm distribution to get a quick start into the prefs system.\n\nDirectory where to store default options/environment/dialogs for building modules that need\nsome customization?\n\nprerequisitespolicy\nThe CPAN module can detect when a module which you are trying to build depends on\nprerequisites. If this happens, it can build the prerequisites for you automatically\n('follow'), ask you for confirmation ('ask'), or just ignore them ('ignore'). Choosing\n'follow' also sets PERLAUTOINSTALL and PERLEXTUTILSAUTOINSTALL for \"--defaultdeps\" if not\nalready set.\n\nPlease set your policy to one of the three values.\n\nPolicy on building prerequisites (follow, ask or ignore)?\n\nrandomizeurllist\nCPAN.pm can introduce some randomness when using hosts for download that are configured in the\nurllist parameter. Enter a numeric value between 0 and 1 to indicate how often you want to let\nCPAN.pm try a random host from the urllist. A value of one specifies to always use a random\nhost as the first try. A value of zero means no randomness at all. Anything in between\nspecifies how often, on average, a random host should be tried first.\n\nRandomize parameter\n\nrecommendspolicy\n(Experimental feature!) Some CPAN modules recommend additional, optional dependencies. These\nshould generally be installed except in resource constrained environments. When this policy is\ntrue, recommended modules will be included with required modules.\n\nInclude recommended modules?\n\nscancache\nBy default, each time the CPAN module is started, cache scanning is performed to keep the\ncache size in sync ('atstart'). Alternatively, scanning and cleanup can happen when CPAN exits\n('atexit'). To prevent any cache cleanup, answer 'never'.\n\nPerform cache scanning ('atstart', 'atexit' or 'never')?\n\nshell\nWhat is your favorite shell?\n\nshowunparsableversions\nDuring the 'r' command CPAN.pm finds modules without version number. When the command\nfinishes, it prints a report about this. If you want this report to be very verbose, say yes\nto the following variable.\n\nShow all individual modules that have no $VERSION?\n\nshowuploaddate\nThe 'd' and the 'm' command normally only show you information they have in their in-memory\ndatabase and thus will never connect to the internet. If you set the 'showuploaddate'\nvariable to true, 'm' and 'd' will additionally show you the upload date of the module or\ndistribution. Per default this feature is off because it may require a net connection to get\nat the upload date.\n\nAlways try to show upload date with 'd' and 'm' command (yes/no)?\n\nshowzeroversions\nDuring the 'r' command CPAN.pm finds modules with a version number of zero. When the command\nfinishes, it prints a report about this. If you want this report to be very verbose, say yes\nto the following variable.\n\nShow all individual modules that have a $VERSION of zero?\n\nsuggestspolicy\n(Experimental feature!) Some CPAN modules suggest additional, optional dependencies. These\n'suggest' dependencies provide enhanced operation. When this policy is true, suggested modules\nwill be included with required modules.\n\nInclude suggested modules?\n\ntarverbosity\nWhen CPAN.pm uses the tar command, which switch for the verbosity shall be used? Choose 'none'\nfor quiet operation, 'v' for file name listing, 'vv' for full listing.\n\nTar command verbosity level (none or v or vv)?\n\ntermislatin\nThe next option deals with the charset (a.k.a. character set) your terminal supports. In\ngeneral, CPAN is English speaking territory, so the charset does not matter much but some CPAN\nhave names that are outside the ASCII range. If your terminal supports UTF-8, you should say\nno to the next question. If it expects ISO-8859-1 (also known as LATIN1) then you should say\nyes. If it supports neither, your answer does not matter because you will not be able to read\nthe names of some authors anyway. If you answer no, names will be output in UTF-8.\n\nYour terminal expects ISO-8859-1 (yes/no)?\n\ntermornaments\nWhen using Term::ReadLine, you can turn ornaments on so that your input stands out against the\noutput from CPAN.pm.\n\nDo you want to turn ornaments on?\n\ntestreport\nThe goal of the CPAN Testers project (http://testers.cpan.org/) is to test as many CPAN\npackages as possible on as many platforms as possible. This provides valuable feedback to\nmodule authors and potential users to identify bugs or platform compatibility issues and\nimproves the overall quality and value of CPAN.\n\nOne way you can contribute is to send test results for each module that you install. If you\ninstall the CPAN::Reporter module, you have the option to automatically generate and deliver\ntest reports to CPAN Testers whenever you run tests on a CPAN package.\n\nSee the CPAN::Reporter documentation for additional details and configuration settings. If\nyour firewall blocks outgoing traffic, you may need to configure CPAN::Reporter before sending\nreports.\n\nGenerate test reports if CPAN::Reporter is installed (yes/no)?\n\nperl5libverbosity\nWhen CPAN.pm extends @INC via PERL5LIB, it prints a list of directories added (or a summary of\nhow many directories are added). Choose 'v' to get this message, 'none' to suppress it.\n\nVerbosity level for PERL5LIB changes (none or v)?\n\npreferexternaltar\nPer default all untar operations are done with the perl module Archive::Tar; by setting this\nvariable to true the external tar command is used if available; on Unix this is usually\npreferred because they have a reliable and fast gnutar implementation.\n\nUse the external tar program instead of Archive::Tar?\n\ntrusttestreporthistory\nWhen a distribution has already been tested by CPAN::Reporter on this machine, CPAN can skip\nthe test phase and just rely on the test report history instead.\n\nNote that this will not apply to distributions that failed tests because of missing\ndependencies. Also, tests can be run regardless of the history using \"force\".\n\nDo you want to rely on the test report history (yes/no)?\n\nurllistpingexternal\nWhen automatic selection of the nearest cpan mirrors is performed, turn on the use of the\nexternal ping via Net::Ping::External. This is recommended in the case the local network has a\ntransparent proxy.\n\nDo you want to use the external ping command when autoselecting mirrors?\n\nurllistpingverbose\nWhen automatic selection of the nearest cpan mirrors is performed, this option can be used to\nturn on verbosity during the selection process.\n\nDo you want to see verbosity turned on when autoselecting mirrors?\n\nusepromptdefault\nWhen this is true, CPAN will set PERLMMUSEDEFAULT to a true value. This causes\nExtUtils::MakeMaker (and compatible) prompts to use default values instead of stopping to\nprompt you to answer questions. It also sets NONINTERACTIVETESTING to a true value to signal\nmore generally that distributions should not try to interact with you.\n\nDo you want to use prompt defaults (yes/no)?\n\nusesqlite\nCPAN::SQLite is a layer between the index files that are downloaded from the CPAN and CPAN.pm\nthat speeds up metadata queries and reduces memory consumption of CPAN.pm considerably.\n\nUse CPAN::SQLite if available? (yes/no)?\n\nversiontimeout\nThis timeout prevents CPAN from hanging when trying to parse a pathologically coded $VERSION\nfrom a module.\n\nThe default is 15 seconds. If you set this value to 0, no timeout will occur, but this is not\nrecommended.\n\nTimeout for parsing module versions?\n\nyamlloadcode\nBoth YAML.pm and YAML::Syck are capable of deserialising code. As this requires a string eval,\nwhich might be a security risk, you can use this option to enable or disable the\ndeserialisation of code via CPAN::DeferredCode. (Note: This does not work under perl 5.6)\n\nDo you want to enable code deserialisation (yes/no)?\n\nyamlmodule\nAt the time of this writing (2009-03) there are three YAML implementations working: YAML,\nYAML::Syck, and YAML::XS. The latter two are faster but need a C compiler installed on your\nsystem. There may be more alternative YAML conforming modules. When I tried two other players,\nYAML::Tiny and YAML::Perl, they seemed not powerful enough to work with CPAN.pm. This may have\nchanged in the meantime.\n\nWhich YAML implementation would you prefer?\n",
                "subsections": []
            },
            "LICENSE": {
                "content": "This program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n",
                "subsections": []
            }
        }
    }
}