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

Создаёт автопакет 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 Consensus: https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/lancaster-consensus.md

Oslo Consensus: 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

Как и в PERL5OPT, строка дополнительных параметров 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, но теперь канонический исходный код находится в указанном репозитории.

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

Japheth Cleaver добавил возможность принудительной установки (-f).

Jim Brandt предложил и реализовал первоначальную функцию отображения обновлений и файлов Changes.

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

АВТОР

brian d foy, <bdfoy@cpan.org>

КОПИРАЙТ

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

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