++ed by:
FSEITZ BESSARABV

2 PAUSE users
2 non-PAUSE users.

perlancar

NAME

pause - A CLI for PAUSE

VERSION

This document describes version 0.64 of main (from Perl distribution App-pause), released on 2017-07-24.

SYNOPSIS

First create a config file ~/pause.conf containing:

 username=<Your PAUSE ID>
 password=<Your PAUSE password>

or if you have ~/.pause from cpan-upload, pause can read it too (encrypted .pause is currently not supported).

Then:

 # upload one or more files
 % pause upload Foo-Bar-0.12.tar.gz Baz-2.24.tar.gz
 % pause upload Foo-Bar-0.12.tar.gz --subdir old/2014; # upload to a subdir

 # list your files
 % pause ls
 % pause ls 'App-*'; # accept filenames/wildcard patterns, note: quote first
 % pause ls -l     ; # see file sizes/mtimes/etc instead of just names

 # list your dists
 % pause ls-dists

 # delete files
 % pause rm Foo-Bar-0.12.tar.gz Foo-Bar-0.12.readme Foo-Bar-0.12.meta
 % pause rm 'Foo-Bar-*'; # accept wildcard patterns, but quote first

 # undelete files scheduled for deletion (but not actually deleted yet)
 % pause undelete Foo-Bar-0.12.tar.gz Foo-Bar-0.12.readme Foo-Bar-0.12.meta
 % pause undelete 'Foo-Bar-*'; # accept wildcard patterns, but quote first

 # force reindexing
 % pause reindex Foo-Bar-0.12.tar.gz Foo-Bar-0.12.meta
 % pause reindex 'Foo-Bar-*'; # accept wildcard patterns, but quote first

 # clean old releases, by default will only leave the newest non-dev version
 % pause cleanup
 % pause cleanup -n 3 ; # keep 3 versions (newest + previous two)

To view permissions:

 # list all modules that you have permissions of
 % pause ls-mods
 % pause ls-mods -l ; # show detail

 # list all modules matching a wildcard
 % pause ls-mods -l 'Unix*'

 # list all modules you have co-maint of
 % pause ls-mods -l --type co-maint

To change permissions (not yet implemented):

 ...

To change your password (not yet implemented):

 ...

To view your account info (not yet implemented):

 ...

To change your email forwarding (not yet implemented):

 ...

SUBCOMMANDS

cleanup

Delete older versions of distributions.

Developer releases will not be deleted.

To delete developer releases, you can use delete_files (rm), e.g. from the command line:

 % pause rm 'My-Module-*TRIAL*'; # delete a dist's trial releases
 % pause rm '*TRIAL*' '*_*'; # delete all files containing TRIAL or underscore

ls

List files.

ls-dists

List distributions.

Distribution names will be extracted from tarball/zip filenames.

Unknown/unparseable filenames will be skipped.

ls-mods

List modules (permissions).

reindex

Force reindexing.

rm

Delete files.

When a file is deleted, it is not immediately deleted but has scheduled_for_deletion status for 72 hours, then deleted. During that time, the file can be undeleted.

undelete

Undelete files.

When a file is deleted, it is not immediately deleted but has scheduled_for_deletion status for 72 hours, then deleted. During that time, the file can be undeleted.

upload

Upload file(s).

OPTIONS

* marks required options.

Common options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--password=s

PAUSE password.

If unset, default value will be searched from `~/.pause`. Encrypted `.pause` is not yet supported.

--quiet

Shortcut for --log-level=error.

--retries=i

Number of retries when received 5xx HTTP error from server.

Default value:

 5
--retry-delay=s

How long to wait before retrying.

Default value:

 3
--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--username=s

PAUSE ID.

If unset, default value will be searched from `~/.pause`. Encrypted `.pause` is not yet supported.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

Options for subcommand cleanup

--detail, -l

Whether to return detailed records.

--num-keep=i, -n

Number of new versions (including newest) to keep.

Default value:

 1

1 means to only keep the newest version, 2 means to keep the newest and the second newest, and so on.

--protect-file=s@

Protect some files/wildcard patterns from delete/cleanup.

Can be specified multiple times.

--protect-files-json=s

Protect some files/wildcard patterns from delete/cleanup (JSON-encoded).

See --protect-file.

Options for subcommand ls

--del

Only list files which are scheduled for deletion.

--detail, -l

Whether to return detailed records.

--file=s@

File name/wildcard pattern.

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

Options for subcommand ls-dists

--detail, -l

Whether to return detailed records.

--newest

Only show newest non-dev version.

Dev versions will be skipped.

--newest-n=i

Only show this number of newest non-dev versions.

Dev versions will be skipped.

Options for subcommand ls-mods

--detail, -l

Whether to return detailed records.

--module=s@

Module name/wildcard pattern.

Can be specified multiple times.

--modules-json=s

Module names/wildcard patterns (JSON-encoded).

See --module.

--type=s

Only list modules matching certain type.

Options for subcommand reindex

--file=s@*

File name/wildcard pattern.

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

Options for subcommand rm

--file=s@*

File name/wildcard pattern.

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

--protect-file=s@

Protect some files/wildcard patterns from delete/cleanup.

Can be specified multiple times.

--protect-files-json=s

Protect some files/wildcard patterns from delete/cleanup (JSON-encoded).

See --protect-file.

Options for subcommand undelete

--file=s@*

File name/wildcard pattern.

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

Options for subcommand upload

--delay=s

Pause a number of seconds between files.

If you upload a lot of files (e.g. 7-10 or more) at a time, the PAUSE indexer currently might choke with SQLite database locking problem and thus fail to index your releases. Giving a delay of say 2-3 minutes (120-180 seconds) between files will alleviate this problem.

--file=s@*

File name/wildcard pattern.

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

--subdir=s

Subdirectory to put the file(s) into.

Default value:

 ""

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C pause pause

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete pause 'p/*/`pause`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/pause.conf, ~/pause.conf, or /etc/pause.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
 password (see --password)
 retries (see --retries)
 retry_delay (see --retry-delay)
 username (see --username)

Configuration for subcommand cleanup

 detail (see --detail)
 num_keep (see --num-keep)
 protect_files (see --protect-file)

Configuration for subcommand ls

 del (see --del)
 detail (see --detail)
 files (see --file)

Configuration for subcommand ls-dists

 detail (see --detail)
 newest (see --newest)
 newest_n (see --newest-n)

Configuration for subcommand ls-mods

 detail (see --detail)
 modules (see --module)
 type (see --type)

Configuration for subcommand reindex

 files (see --file)

Configuration for subcommand rm

 files (see --file)
 protect_files (see --protect-file)

Configuration for subcommand undelete

 files (see --file)

Configuration for subcommand upload

 delay (see --delay)
 files (see --file)
 subdir (see --subdir)

ENVIRONMENT

PAUSE_OPT => str

Specify additional command-line options.

FILES

~/.config/pause.conf

~/pause.conf

/etc/pause.conf

~/.pause

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-pause.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-pause.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-pause

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017, 2016, 2015 by perlancar@cpan.org.

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