cpan

СОДЕРЖАНИЕ

• НАЗВАНИЕ
• СИНТАКСИС
• ОПИСАНИЕ
  • Параметры
  • Примеры
  • Переменные окружения
• КОДЫ ВЫХОДА
• ЗАДАЧИ
• ОШИБКИ
• СМОТРИТЕ ТАКЖЕ
• ДОСТУПНОСТЬ ИСТОЧНИКА
• АВТОРСКИЕ ПРАВА
• АВТОР
• КОПИРАЙТ

НАЗВАНИЕ

cpan - лёгкое взаимодействие с CPAN из командной строки

СИНТАКСИС

# with arguments and no switches, installs specified modules
cpan module_name [ module_name ... ]

# with switches, installs modules with extra behavior
cpan [-cfFimtTw] module_name [ module_name ... ]

# use local::lib
cpan -I module_name [ module_name ... ]

# one time mirror override for faster mirrors
cpan -p ...

# with just the dot, install from the distribution in the
# current directory
cpan .

# without arguments, starts CPAN.pm shell
cpan

# without arguments, but some switches
cpan [-ahpruvACDLOPX]

ОПИСАНИЕ

Этот скрипт предоставляет интерфейс командной строки (не оболочку) для CPAN. В настоящее время он использует CPAN.pm для выполнения работы, но это не одноразовый командный запуск для CPAN.pm.

Параметры

-a

Создаёт пакет autobundle для CPAN.pm с помощью CPAN::Shell->autobundle.

-A module [ module ... ]

Отображает основных авторов указанных модулей.

-c module

Выполняет `make clean` в директориях указанного модуля.

-C module [ module ... ]

Отображает файлы Changes для указанных модулей.

-D module [ module ... ]

Отображает подробности модуля. Это выводит одну строку для каждого устаревшего модуля (то есть, модули, локально установленные, но имеющие более новые версии в CPAN). Каждая строка имеет три столбца: имя модуля, локальная версия и версия CPAN.

-f

Принудительно выполняет указанное действие, когда оно обычно потерпело бы неудачу. Используйте это, чтобы установить модуль, даже если его тесты завершаются с ошибкой. При использовании этого параметра, -i не является необязательным при установке модуля, если его нужно принудительно установить:

% cpan -f -i Module::Foo

-F

Отключает попытки CPAN.pm заблокировать что-либо. Будьте осторожны, так как это может привести к тому, что несколько скриптов попытаются модифицировать одну и ту же директорию. Это не так актуально, если вы загружаете специальную конфигурацию с -j, и эта конфигурация настраивает свои рабочие директории.

-g module [ module ... ]

Загружает в текущую директорию последнюю версию дистрибутива модуля.

-G module [ module ... ]

НЕ РЕАЛИЗОВАНО

Загружает в текущую директорию последнюю версию дистрибутива модулей, распаковывает каждый дистрибутив и создаёт репозиторий Git для каждого дистрибутива.

Если вам нужна эта функция, посмотрите дистрибутив Git::CPAN::Patch Яника Шампу.

-h

Выводит сообщение справки и завершает работу. Если вы укажете -h, он игнорирует все остальные параметры и аргументы.

-i module [ module ... ]

Устанавливает указанные модули. Без других переключателей этот переключатель подразумевается.

-I

Загружает local::lib (подумайте, как -I для загрузки путей библиотек). Жаль, что -l уже занято.

-j Config.pm

Загружает файл с данными конфигурации CPAN. Он должен иметь тот же формат, что и стандартный файл CPAN/Config.pm, который определяет $CPAN::Config как анонимный массив.

-J

Выводит конфигурацию в том же формате, что и CPAN.pm. Это полезно для проверки конфигурации, а также для использования вывода в качестве отправной точки для новой, настраиваемой конфигурации.

-l

Отображает все установленные модули с их версиями.

-L author [ author ... ]

Отображает модули по указанным авторам.

-m

Создаёт указанные модули.

-M mirror1,mirror2,...

Список зеркал, разделённый запятыми, которые нужно использовать только для этого запуска. Параметр -P может автоматически найти их для вас.

-n

Выполняет пробный запуск, но ничего не устанавливает. (не реализовано)

-O

Отображает устаревшие модули.

-p

Отправляет запрос к настроенным зеркалам и выводит отчёт.

-P

Находит лучшие зеркала, которые можно использовать, и использует их для текущего сеанса.

-r

Перекомпилирует динамически загруженные модули с помощью CPAN::Shell->recompile.

-s

Запускает оболочку CPAN.pm. Эта команда выполняется автоматически, если вы не указываете никаких аргументов.

-t module [ module ... ]

Выполняет `make test` для указанных модулей.

-T

Не тестировать модули. Просто установить их.

-u

Обновить все установленные модули. Необдуманное выполнение может привести к ошибкам, поэтому сохраните резервную копию.

-v

Выводит версию скрипта и версию CPAN.pm, а затем завершает работу.

-V

Выводит подробную информацию о клиенте cpan.

-w

НЕ РЕАЛИЗОВАНО

Включает предупреждения cpan. Это проверяет различные вещи, такие как права на директории, и сообщает о возможных проблемах.

-x module [ module ... ]

Находит близкие совпадения с указанными модулями, которые вы, возможно, неправильно набрали. Для этого требуется необязательная установка Text::Levenshtein или Text::Levenshtein::Damerau.

-X

Выводит все пространства имён в стандартный вывод.

Примеры

# print a help message
cpan -h

# print the version numbers
cpan -v

# create an autobundle
cpan -a

# recompile modules
cpan -r

# upgrade all installed modules
cpan -u

# install modules ( sole -i is optional )
cpan -i Netscape::Booksmarks Business::ISBN

# force install modules ( must use -i )
cpan -fi CGI::Minimal URI

# install modules but without testing them
cpan -Ti CGI::Minimal URI

Переменные окружения

Несколько компонентов в CPAN.pm используют переменные окружения. Инструменты сборки, ExtUtils::MakeMaker и Module::Build используют некоторые из них, в то время как другие важны для более высоких уровней. Некоторые из них определены Perl Toolchain Gang:

Lancaster Concensus: https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/lancaster-consensus.md

Oslo Concensus: https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/oslo-consensus.md

NONINTERACTIVE_TESTING

Предполагается, что никто не следит за процессом и пропускаются запросы для дистрибутивов, которые это делают правильно. cpan(1) устанавливает это в значение 1, если оно ещё не имеет значения (даже если это значение ложно).

PERL_MM_USE_DEFAULT

Использовать значение по умолчанию для запрошенных вопросов. cpan(1) устанавливает это в значение 1, если оно ещё не имеет значения (даже если это значение ложно).

CPAN_OPTS

Как и PERL5OPTS, строка дополнительных cpan(1) параметров для добавления к тем, которые вы указываете в командной строке.

CPANSCRIPT_LOGLEVEL

Уровень ведения журнала, который следует использовать, либо с встроенным минимальным логированием, либо с Log::Log4perl, если оно установлено. Возможные значения такие же, как и у Log::Log4perl уровней: TRACE, DEBUG, INFO, WARN, ERROR, и FATAL. Значение по умолчанию INFO.

GIT_COMMAND

Путь к исполняемому файлу git для использования функций Git. Значение по умолчанию /usr/local/bin/git.

КОДЫ ВЫХОДА

Скрипт завершается с кодом 0, если всё прошло успешно, или положительным числом, если произошла ошибка. Однако в некоторых случаях ему нужно определить ошибку по выводу вещей, которыми он не управляет. На данный момент коды выхода неточны:

1       An unknown error

2       The was an external problem

4       There was an internal problem with the script

8       A module failed to install

ЗАДАЧИ

* значения конфигурации из командной строки в режиме одного вызова

ОШИБКИ

* не обнаружено

СМОТРИТЕ ТАКЖЕ

Большинство функций, включая переменные окружения и конфигурацию, напрямую берутся из CPAN.pm.

ДОСТУПНОСТЬ ИСТОЧНИКА

Этот код находится в репозитории CPAN.pm на Github:

https://github.com/andk/cpanpm

Ранее исходный код отслеживался отдельно в другом репозитории GitHub, но теперь он находится в указанном выше репозитории.

АВТОРСКИЕ ПРАВА

Джафеф Кливер добавил части, позволяющие принудительную установку (-f).

Джим Брандт предложил и реализовал начальную версию функций обновления и отображения изменений.

Адам Кеннеди указал, что exit() вызывает проблемы в Windows, где этот скрипт получает расширение .bat

АВТОР

brian d foy, <bdfoy@cpan.org>

КОПИРАЙТ

Copyright (c) 2001-2015, brian d foy, Все права защищены.

Вы можете распространять его на тех же условиях, что и Perl сам по себе.