From EPrints Documentation
Revision as of 13:49, 29 January 2015 by Th.lauke@arcor.de (talk | contribs) (pointing out to useful list of available plugins)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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


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


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


export repository_id [options] dataset

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


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.

bin/export <REPOSITORYID> eprint --verbose

presents a list of all available export plugins (as well as missing perl modules causing some deactivations).


  • repository_id
The ID of the EPrint repository to use.
  • dataset
The name of the dataset to export, such as "archive", "subject" or "user".
  • 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.
  • objectid
If this is set then just output the single, specified item or items.


  • --argument key=value
Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.
  • --help
Print a brief help message and exit.
  • --man
Print the full manual page and then exit.
  • --quiet
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
  • --verbose
Explain in detail what is going on. May be repeated for greater effect.
Shows why a plugin is disabled.
  • --version
Output version information and exit.


Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.