Editing API:bin/export

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/export|package_name=bin/export}}[[Category:API|BIN/EXPORT]][[Category:API:bin/export|BIN/EXPORT]][[Category:API:bin/export|BIN/EXPORT]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''export''' - export some or all items in a dataset using an output plugin.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_synopsis -->
==SYNOPSIS==
'''export''' <em>repository_id</em> ['''options'''] <em>dataset</em> 

'''export''' <em>repository_id</em> ['''options'''] <em>dataset</em> <em>plugin</em> [<em>objectid</em>] [<em>objectid...</em>]

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==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 &lt;eprint&gt; elements in an outer &lt;eprints&gt; 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 &lt;?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).

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_arguments -->

==ARGUMENTS==
* <em>repository_id</em> 
: The ID of the EPrint repository to use.

* <em>dataset</em>
: The name of the dataset to export, such as "archive", "subject" or "user".

* <em>plugin</em>
: 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.

* <em>objectid</em>
: If this is set then just output the single, specified item or items.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_options -->
==OPTIONS==
* '''--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.

<pre>
  
</pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
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/.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->