Difference between revisions of "API:bin/lift embargos"

From EPrints Documentation
Jump to: navigation, search
(Added API:bin page for lift_embargos)
 
m
 
Line 26: Line 26:
 
This script will:
 
This script will:
  
   - search the repository for documents which have an expired publisher- or funder-imposed embargo date (relative to the system date)
+
   - search the repository for documents which have an expired publisher or funder-imposed embargo date (relative to the system date)
 
   - make all documents whose embargo has expired publically available
 
   - make all documents whose embargo has expired publically available
 
   - remove the expired embargo date value
 
   - remove the expired embargo date value

Latest revision as of 13:47, 5 March 2022

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

lift_embargos - lift expired publisher- or funder-imposed embargos from a repository


SYNOPSIS

lift_embargos - repository_id [options]


DESCRIPTION

Lift expired publisher- or funder-imposed embargos from a repository.

This script will:

 - search the repository for documents which have an expired publisher or funder-imposed embargo date (relative to the system date)
 - make all documents whose embargo has expired publically available
 - remove the expired embargo date value
 - re-generate the abstract page for the eprint

Note that this considers the date to be the local date, not the UTC date.


ARGUMENTS

repository_id
The ID of the EPrint repository to search.


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.
--dry-run
Don't perform an actual changes.
--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/.