|
|
| Line 1: |
Line 1: |
| − | <!-- 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=EPrints.pm|package_name=EPrints}}[[Category:API|EPrints]]<div><!-- Edit below this comment -->
| |
| | | | |
| − |
| |
| − | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
| |
| − | ==NAME==
| |
| − | '''EPrints''' - Institutional Repository software
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_synopsis -->
| |
| − | ==SYNOPSIS==
| |
| − | use EPrints qw();
| |
| − |
| |
| − | my $session = EPrints::Session->new( 1, "demoprints" );
| |
| − |
| |
| − | ...
| |
| − |
| |
| − | $session->terminate;
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_description -->
| |
| − | ==DESCRIPTION==
| |
| − | See http://www.eprints.org/.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_available_symbols -->
| |
| − | ===Available Symbols===
| |
| − | You can pass options to the EPrints package that effect the EPrints initialisation e.g.
| |
| − |
| |
| − | use EPrints qw( no_check_user );
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=item_no_check_user -->
| |
| − | ====no_check_user====
| |
| − |
| |
| − | Do not check the current user/group is the same as the user/group in Systemsettings.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_debugging_slow_processes -->
| |
| − | ===Debugging Slow Processes===
| |
| − | This module installs a signal handler that will print a stack trace if given a USR2 signal (if your system supports this signal). To print a stack trace to the error log execute:
| |
| − |
| |
| − | $ kill -USR2 PID
| |
| − |
| |
| − | Where PID is the id number of the stalled process.
| |
| − |
| |
| − | A shell script will print the stack trace to the console.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_methods -->
| |
| − | ==METHODS==
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=item_abort -->
| |
| − | ===EPrints->abort( $errmsg )===
| |
| − |
| |
| − | Print an error message and exit. If running under mod_perl then print the error as a webpage and exit.
| |
| − |
| |
| − | This subroutine is loaded before other modules so that it may be used to report errors when initialising modules.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=item_new -->
| |
| − | ===$ep = EPrints->new();===
| |
| − |
| |
| − | Construct a new EPrints system object.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=item_repository -->
| |
| − | ===$repo = $ep->repository( $repository_id, %options );===
| |
| − |
| |
| − | Return the repository with the given ID, or undef. Options are... optional.
| |
| − |
| |
| − | Options noise=>1, etc.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=item_current_repository -->
| |
| − | ===$repo = $ep->current_repository( %options );===
| |
| − |
| |
| − | Return the repository based on the current web request, or undef.
| |
| − |
| |
| − | %options as for $ep->repository(..)
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=item_repository_ids -->
| |
| − | ===@ids = $eprints->repository_ids===
| |
| − |
| |
| − | Returns a list of the active repository ids.
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_see_also -->
| |
| − | ==SEE ALSO==
| |
| − | [[API:EPrints/Session|EPrints::Session]]
| |
| − |
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=head_copyright -->
| |
| − | ==COPYRIGHT==
| |
| − | __COPYRIGHT__
| |
| − |
| |
| − | Copyright 2000-2008 University of Southampton. All Rights Reserved.
| |
| − |
| |
| − | __LICENSE__
| |
| − | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
| |
| − | <span style='display:none'>User Comments</span>
| |
| − | <!-- Edit below this comment -->
| |
| − |
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − |
| |
| − | <!-- Pod2Wiki= -->
| |
| − | </div>
| |
| − | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
| |
