Difference between revisions of "API:bin/export"

From EPrints Documentation
Jump to: navigation, search
(Created page with '<!-- 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' com…')
 
Line 53: Line 53:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_i_repository_id -->
 
<!-- Pod2Wiki=item_i_repository_id -->
=== ===
+
===<em>repository_id</em> ===
  
 
The ID of the EPrint repository to use.
 
The ID of the EPrint repository to use.
Line 65: Line 65:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_i_dataset -->
 
<!-- Pod2Wiki=item_i_dataset -->
======
+
===<em>dataset</em>===
  
 
The name of the dataset to export, such as "archive", "subject" or "user".
 
The name of the dataset to export, such as "archive", "subject" or "user".
Line 77: Line 77:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_i_plugin -->
 
<!-- Pod2Wiki=item_i_plugin -->
======
+
===<em>plugin</em>===
  
 
The id of the output plugin to use. This should not include the leading "Export::". Examples: BibTeX, XML.
 
The id of the output plugin to use. This should not include the leading "Export::". Examples: BibTeX, XML.
Line 91: Line 91:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_i_objectid -->
 
<!-- Pod2Wiki=item_i_objectid -->
======
+
===<em>objectid</em>===
  
 
If this is set then just output the single, specified item or items.
 
If this is set then just output the single, specified item or items.
Line 112: Line 112:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_b_arg_key_value -->
 
<!-- Pod2Wiki=item_b_arg_key_value -->
======
+
==='''--arg key=value'''===
  
 
Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.
 
Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.
Line 124: Line 124:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_b_help -->
 
<!-- Pod2Wiki=item_b_help -->
======
+
==='''--help'''===
  
 
Print a brief help message and exit.
 
Print a brief help message and exit.
Line 136: Line 136:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_b_man -->
 
<!-- Pod2Wiki=item_b_man -->
======
+
==='''--man'''===
  
 
Print the full manual page and then exit.
 
Print the full manual page and then exit.
Line 148: Line 148:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_b_quiet -->
 
<!-- Pod2Wiki=item_b_quiet -->
======
+
==='''--quiet'''===
  
 
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
 
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
Line 160: Line 160:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_b_verbose -->
 
<!-- Pod2Wiki=item_b_verbose -->
======
+
==='''--verbose'''===
  
 
Explain in detail what is going on. May be repeated for greater effect.
 
Explain in detail what is going on. May be repeated for greater effect.
Line 174: Line 174:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_b_version -->
 
<!-- Pod2Wiki=item_b_version -->
======
+
==='''--version'''===
  
 
Output version information and exit.
 
Output version information and exit.

Revision as of 14:37, 25 February 2010

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