API:bin/export

From EPrints Documentation
Revision as of 10:47, 25 August 2011 by Tdb01r (Talk | contribs)

Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

export - export some or all items in a dataset using an output plugin.

User Comments


SYNOPSIS

export repository_id [options] dataset

export repository_id [options] dataset plugin [objectid] [objectid...]

User Comments


DESCRIPTION

This command outputs a dataset in the selected format. The formats available depend on what Export plugins have been installed.

Some plugins only operate on lists (e.g. RSS), others only operate on single objects only. Some plugins act slightly differently in single-item only mode. For example, outputing a list of eprints as XML gives a number of <eprint> elements in an outer <eprints> element.

To get the plugin to export a single item use --single. This may not always return a complete file. For example it may be missing the <?xml header, depending on the plugin.

User Comments


ARGUMENTS

User Comments


repository_id

The ID of the EPrint repository to use.

User Comments


dataset

The name of the dataset to export, such as "archive", "subject" or "user".

User Comments


plugin

The id of the output plugin to use. This should not include the leading "Export::". Examples: BibTeX, XML.

If this is ommited or an invalid plugin is requested, then 'export' will list all plugins compatible with the dataset and exit.

User Comments


objectid

If this is set then just output the single, specified item or items.

User Comments


OPTIONS

User Comments


--arg key=value

Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.

User Comments


--help

Print a brief help message and exit.

User Comments


--man

Print the full manual page and then exit.

User Comments


--quiet

Be vewwy vewwy quiet. This option will supress all output unless an error occurs.

User Comments


--verbose

Explain in detail what is going on. May be repeated for greater effect.

Shows why a plugin is disabled.

User Comments


--version

Output version information and exit.

User Comments


COPYRIGHT

User Comments