API:bin/toolbox

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.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

toolbox - EPrints Toolbox

SYNOPSIS

toolbox repository_id [options] getEprint --eprint eprintid

toolbox repository_id [options] getEprintField --eprint eprintid --field fieldname

toolbox repository_id [options] createEprint < data

toolbox repository_id [options] modifyEprint --eprint eprintid < data

toolbox repository_id [options] removeEprint --eprint eprintid

toolbox repository_id [options] addDocument --eprint eprintid < data

toolbox repository_id [options] modifyDocument --document documentid < data

toolbox repository_id [options] removeDocument --document documentid

toolbox repository_id [options] getFile --document documentid --filename filename

toolbox repository_id [options] addFile --document documentid --filename filename < data

toolbox repository_id [options] removeFile --document documentid --filename filename

toolbox repository_id [options] idSearchEprints < data

toolbox repository_id [options] xmlSearchEprints < data

DESCRIPTION

This command provides some remote access to read and write to the EPrints repository. Be careful, there are no safety checks!

ARGUMENTS

repository_id

The ID of the EPrint repository to use.

OPTIONS

--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

Copyright 2022 University of Southampton. EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

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

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 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 Lesser General Public License for more details.

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