/ 
Pinto-Remote-0.001
/ pinto-admin

NAME

pinto-admin - administer a Pinto repository

VERSION

version 0.001

SYNOPSIS

pinto-remote [global options] COMMAND [command options] [ARGS]

pinto-remote help COMMAND

pinto-remote help

DESCRIPTION

pinto-remote is a command line utility for managing a remote Pinto repository. See pinto-admin for information on creating a Pinto repository, and pinto-server for information on providing remote access to the repository.

Once a Pinto repository has been established and the server is running, you can use pinto-remote to add distributions, remove packages, or inspect the contents of the repository.

CONFIGURATION

The following parameters can be set in your configuration file. The default location of this file is ~/.pinto/config.ini. You may specify an alternative location for this file by setting the PERL_PINTO environment variable to point to another path.

The configuration file is in the typical INI format. Parameters are NAME = VALUE pairs. Global parameters (which are all the ones described below) are at the top of the file. Blank lines are ignored, leading and trailing whitespace is discarded. Comments start with a semi-colon (;).

Almost all configuration parameters can also be specified on the command line, either as global options or command options, so strictly speaking, a configuration file is not mandatory.

pinto-remote shares the same configuration file as pinto-admin and pinto-server. So if you've configured those, then the only thing you may want to add is the [Pinto::Remote] section.

author = NAME

Your identity as a module author. This could be your PAUSE ID, but it doesn't have to be. As long as it is just alphanumeric characters. This defaults to your shell username (either $ENV{USERNAME} or $ENV{USER} or $ENV{LOGNAME}). This parameter is only relevant to the add and remove commands.

If you have a team of developers and you want them all to be able to add/remove the same packages to the repository, then everyone on the team should use the same author parameter.

host = URL

The path to a directory where your repository will be kept. This parameter is required for all commands. You must be able to read and write to this directory. You may use a tilde (~) as shorthand for your home directory.

quiet = 0|1

If true, then only fatal error messages will be displayed. This parameter silently overrides any verbose setting.

verbose = 0|1|2

Controls how much noise is made. Default is 0.

COMMANDS

The following commands are available. Say pinto-remote help COMMAND to display a list of options available for that COMMAND.

add Some-Distribution-1.2.tar.gz

Adds the given distribution to the Pinto repository. Any packages contained in that distribution will mask the foreign packages with the same name. See the "BEHAVIOR" section for more information about how locally added distributions interact with foreign ones.

list

Lists all the curent packages and distributions that are indexed in your remote repository. This is basically just the contents of the 02packages.details.txt.gz file.

remove Some::Package

Removes the distribution that contains the given package. All other packages that were contained in the same distribution are also removed. You can only remove a package that YOU have added. You cannot remove foreign packages that were pulled in from a remote source (however you can mask them by adding your own versions).

BEHAVIOR

There are certain rules that govern how a Pinto repository behaves. These rules are intended to ensure that clients installing packages from your repository will always get the right ones. Also, the rules attempt to make Pinto behave somewhat like PAUSE does.

A local package always masks a foreign package, and all other packages that are in the same distribution with the foreign package.

This is important, so pay attention. If you add a distribution that contains both Foo and Bar packages, and you later add another distribution that contains just the Foo package, then both the foreign Foo and Bar packages will be removed from your index. This ensures that anyone installing packages from your repository will always get your version of Foo. But they'll never be able to get Bar, because doing so would overwrite your Foo.

You can never add a distribution with the same name twice.

Most distribution-building tools will put some kind of version number in the name of the distribution, so this is rarely a problem. The "name" of a distribution is actually a function of the name of the file and the name of the author. So technically, it is possible for two different authors to both add a distribution called Foo-Bar-1.2.tar.gz. But in practice, this rarely happens because...

Only the original author of a local package can add an distribution that contains the same package.

Ownership is given on a first-come basis, just like PAUSE. So if SALLY is the first author to add a distribution to the repository with package Foo::Bar, then only SALLY can ever add another distribution with that package again. Unless that package is explicitly removed, but...

Only the original author of a local package can remove it.

Just like when adding new versions of a local package, only the original author can remove it. Yes, you can just change the author parameter in your configuration, but SALLY probably wouldn't appreciate you messing with her releases (unless SALLY no longer works here).

AUTHOR

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Imaginative Software Systems.

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