Metadata-Version: 2.0
Name: doppel
Version: 0.3.1
Summary: A friendly file copier/installer
Home-page: https://github.com/jimporter/doppel
Author: Jim Porter
Author-email: itsjimporter@gmail.com
License: BSD
Description-Content-Type: UNKNOWN
Keywords: file copier and installer
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: elevate (>=0.1.2)
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8 (>=3.0); extra == 'dev'
Requires-Dist: pypandoc; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: flake8 (>=3.0); extra == 'test'

doppel
======

**doppel** copies files or directories to a destination (a file,
directory, or archive). Think of it as the offspring of
`*install(1)* <http://linux.die.net/man/1/install>`__ and
`*tar(1)* <http://linux.die.net/man/1/tar>`__.

Usage
-----

::

    doppel [OPTION]... SOURCE... DEST

To copy files or directories, just list the sources as arguments
followed by the destination: ``doppel src1 src2 dst``. By default, if
only one source is specified, it is copied *onto* the destination; if
multiple sources are specified, they are copied *into* the destination.
This default can be explicitly specified with ``-o/--onto`` or
``-i/--into``, respectively.

If the destination requires administrator access to write to, doppel
will try to detect this an automatically provide a ``sudo`` (or
equivalent) prompt before copying.

Options
-------

-C, --directory=DIR
~~~~~~~~~~~~~~~~~~~

Change to directory ``DIR`` before resolving paths of source files.

-f, --format=FMT
~~~~~~~~~~~~~~~~

Set the format of the output archive; one of: ``tar``, ``gzip``,
``bzip2``, or ``zip``. If this option is specified, ``--into`` is
implied. If not set, source files will be copied normally, and no
archive will be created.

-i, --into
~~~~~~~~~~

Copy sources into directory ``DEST``.

-m, --mode=MODE
~~~~~~~~~~~~~~~

Set the file permissions to ``MODE`` (an octal) when copying. Note: this
has no effect when ``--format=zip``.

-N, --full-name
~~~~~~~~~~~~~~~

When copying, use the full name of each source file as specified on the
command line instead of just the tail. This behavior is similar to
`*tar(1)* <http://linux.die.net/man/1/tar>`__.

-o, --onto
~~~~~~~~~~

Copy a single source onto file or directory ``DEST``.

-p, --parents
~~~~~~~~~~~~~

Automatically create parent directories for ``DEST`` as needed.

-P, --dest-prefix=DIR
~~~~~~~~~~~~~~~~~~~~~

A prefix to add to the paths of destination files. This only applies
when using ``--format``.

-r, --recursive
~~~~~~~~~~~~~~~

Recursively copy source directories to the destination.

-S, --sudo=WHEN
~~~~~~~~~~~~~~~

Before copying, elevate with ``sudo`` (or your platform's equivalent).
``WHEN`` is one of ``always``, ``auto`` (the default), or ``never``. If
``auto``, doppel will attempt to determine automatically if ``sudo``
would be needed before performing the copy.

@file
~~~~~

Read options from ``file`` and use them when executing.

--help
~~~~~~

Display a help message and exit.

--version
~~~~~~~~~

Output version information and exit.

License
-------

This project is licensed under the `BSD 3-clause license <LICENSE>`__.


