commit ffd00b5c245666a842da65aeb678961465188aeb Author: František Dvořák Date: Sun Jun 22 00:25:23 2014 +0200 Add man pages missing in lb.utils (Fedora Review #1052852). diff --git a/org.glite.lb.utils/Makefile b/org.glite.lb.utils/Makefile index a94e86e..26bfb34 100644 --- a/org.glite.lb.utils/Makefile +++ b/org.glite.lb.utils/Makefile @@ -78,7 +78,7 @@ UTILS:=purge dump load ALLUTILS:=${UTILS} mon dump_exporter state_history statistics STATISTICS_OBJS:=statistics.o process_attrs.o process_attrs2.o -MAN_GZ:=glite-lb-dump.1.gz glite-lb-load.1.gz glite-lb-purge.1.gz glite-lb-mon.1.gz +MAN_GZ:=glite-lb-bkpurge-offline.1.gz glite-lb-dump.1.gz glite-lb-dump_exporter.1.gz glite-lb-load.1.gz glite-lb-purge.1.gz glite-lb-mon.1.gz glite-lb-state_history.1.gz glite-lb-statistics.1.gz MAN = $(MAN_GZ:.gz=) compile all: ${ALLUTILS} ${MAN_GZ} diff --git a/org.glite.lb.utils/doc/glite-lb-bkpurge-offline.1 b/org.glite.lb.utils/doc/glite-lb-bkpurge-offline.1 new file mode 100644 index 0000000..2a58278 --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-bkpurge-offline.1 @@ -0,0 +1,76 @@ +.TH GLITE-LB-BKPURGE-OFFLINE 1 "Jun 2014" "CESNET" "Logging & Bookkeeping Utils" + + +.SH NAME +glite-lb-bkpurge-offline - emergency utility for removing inactive jobs from the L&B database + + +.SH SYNOPSIS +\fBglite-lb-bkpurge-offline\fR [\fIOPTIONS\fR] + + +.SH DESCRIPTION +\fBglite-lb-bkpurge-offline\fR is utility for removing inactive jobs from the L&B database. By default, it removes jobs that reached CLEARED, ABORTED and CANCELED state and also OTHER and DONE jobs that are inactive for specific (rather long) time. It calls directly database SQL commands. + +This utility is provided for \fBemergency and expert use only\fR. Exact semantics of job age are slightly different from regular \fBglite-lb-bkpurge\fR, there is no synchronization with running L&B server and/or proxy when jobs receive new events while being purged, and error handling is minimal. + + +.SH OPTIONS +.TP +\fB\-a\fR \fINNN\fR\fi[smhd]\fR +Purge ABORTED jobs older than NNN seconds/minutes/hours/days (only one number and one letter allowed). If the time is not specified, the default timeout is determined by the server. + +.TP +\fB\-c\fR \fINNN\fR\fi[smhd]\fR +Purge CLEARED jobs older than given time. + +.TP +\fB\-d\fR \fINNN\fR\fi[smhd]\fR +Purge DONE jobs older than given time. + +.TP +\fB\-h\fR +Display help. + +.TP +\fB\-m\fR \fIBKSERVER\fR +L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is being checked. + +.TP +\fB\-M\fR \fi{singleshot|staged}\fR +Cleaning method (default=staged). + +.TP +\fB\-n\fR \fINNN\fR\fi[smhd]\fR +Purge CANCELED jobs older than given time. + +.TP +\fB\-o\fR \fINNN\fR\fi[smhd]\fR +Purge OTHER (i.e. job in other state than ABORTED, CLEARED or CANCELED) jobs older than given time. + +.TP +\fB\-p\fR +Purge L&B proxy database (default: L&B server DB). + +.TP +\fB-t\fR +Free unused space if using MyISAM DB engine. By default MyISAM is not used by default in L&B deployments. + + +.SH ENVIRONMENT +.TP +\fBEDG_WL_QUERY_SERVER\fR +If \fB$EDG_WL_QUERY_SERVER\fR is set, its value is used as the bkserver address. + + +.SH BUGS +Please report all bugs to CESNET gLite L&B issue tracker available at +.I https://github.com/CESNET/glite-lb/issues + + +.SH AUTHORS +L&B Product Team, CESNET. + + +.SH SEE ALSO + \fBglite-lb-purge\fP(1) diff --git a/org.glite.lb.utils/doc/glite-lb-dump_exporter.1 b/org.glite.lb.utils/doc/glite-lb-dump_exporter.1 new file mode 100644 index 0000000..0c4a934 --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-dump_exporter.1 @@ -0,0 +1,50 @@ +.TH GLITE-LB-DUMP_EXPORTER 1 "Jun 2014" "CESNET" "Logging & Bookkeeping Utils" + + +.SH NAME +glite-lb-dump_exporter - L&B dump exporter for Job Provenance + + +.SH SYNOPSIS +\fBglite-lb-dump_exporter\fR [\fIOPTIONS\fR] + + +.SH DESCRIPTION +\fBglite-lb-dump_exporter\fR parses complete L&B jobs events dump file, creates one file per every job, and update information in message directory for further processing. + +This utility is used together with \fBglite-jp-importer\fR daemon for importing L&B dumps to Job Provenance. + + +.SH OPTIONS +.TP +\fB\-d\fR, \fP--dump\fR \fIFILE\fR +L&B dump file location. The file is generated by the \fBglite-lb-purge\fR. + +.TP +\fB\-h\fR, \fP--help\fR +Display help. + +.TP +\fB\-j\fR, \fP--jpps\fR \fIHOST:PORT\fR +Target Job Provenance Primary Storage, where the files should be uploaded. + +.TP +\fB\-m\fR, \fP--lbmaildir\fR \fIDIRECTORY\fR +Directory, where should be stored the message describing the file upload. It is read by \fBglite-jp-importer\fR. + +.TP +\fB\-s\fR, \fP--store\fR \fIDIRECTORY\fR +Directory, where to store all dump files. + + +.SH BUGS +Please report all bugs to CESNET gLite L&B issue tracker available at +.I https://github.com/CESNET/glite-lb/issues + + +.SH AUTHORS +L&B Product Team, CESNET. + + +.SH SEE ALSO +\fBglite-lb-purge\fP(1), \fBglite-lb-statistics\fP(1), \fBglite-jp-importer\fP(8) diff --git a/org.glite.lb.utils/doc/glite-lb-state_history.1 b/org.glite.lb.utils/doc/glite-lb-state_history.1 new file mode 100644 index 0000000..154df30 --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-state_history.1 @@ -0,0 +1,44 @@ +.TH GLITE-LB-STATE_HISTORY 1 "Jun 2014" "CESNET" "Logging & Bookkeeping Utils" + + +.SH NAME +glite-lb-state_history - utility to show job state changes stored in Logging and Bookkeeping + + +.SH SYNOPSIS +\fBglite-lb-state_history\fR [\fB\-f\fR \fIFIELDS\fR] \fIJOBID\fR + + +.SH DESCRIPTION +\fBglite-lb-state_history\fR shows the job state changes from the events stored in Logging and Bookkeeping. + + +.SH OPTIONS +.TP +\fB\-f\fR \fIFIELDS\fR +Job status fields to show in the history listing. + +Basic information always shown: + \fBevent name\fR + \fBjobid\fR + \fBjob status\fR + +Fields shown by default: + \fBnetwork_server\fR + \fBjdl:VirtualOrganisation\fR + \fBdestination\fR + \fBdone_code\fR + \fBreason\fR + + +.SH BUGS +Please report all bugs to CESNET gLite L&B issue tracker available at +.I https://github.com/CESNET/glite-lb/issues + + +.SH AUTHORS +L&B Product Team, CESNET. + + +.SH SEE ALSO +\fBglite-lb-mon\fP(1), \fBglite-lb-statistics\fP(1) diff --git a/org.glite.lb.utils/doc/glite-lb-statistics.1 b/org.glite.lb.utils/doc/glite-lb-statistics.1 new file mode 100644 index 0000000..9b31aba --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-statistics.1 @@ -0,0 +1,54 @@ +.TH GLITE-LB-STATISTICS 1 "Jun 2014" "CESNET" "Logging & Bookkeeping Utils" + + +.SH NAME +glite-lb-statistics - tool for converting L&B job dump to Job History Record in XML + + +.SH SYNOPSIS +\fBglite-lb-statistics\fR [\fIOPTIONS\fR] + + +.SH DESCRIPTION +\fBglite-lb-statistics\fR takes a dump file for one job and converts it to XML encoded Job History Record that contains all the relevant information from the job life. The Job History Records can be fed into a statistical tools to reveal interesting information about the job behavior within the Grid. + +The dump file should be a dump for one job only. Typically it is used \fBglite-lb-dump_exporter\fR(1) utility to convert L&B server dumps for further processing by \fBglite-lb-statistics\fR(1). + + +.SH OPTIONS +.TP +\fB\-1\fR, \fP\-\-versionone\fR +Use version 1 of the attributes (it is obsolete now). + +.TP +\fB\-f\fR, \fPfile\fR \fIFILE\fR +A dump file to process. + +.TP +\fB\-h\fR, \fP\-\-help\fR +Display help and exit. + +.TP +\fB\-o\fR, \fP\-\-outfile\fR \fIFILE\fR +Output filename. + +.TP +\fB\-V\fR, \fP\-\-version\fR +Output version information and exit. + +.TP +\fB\-v\fR, \fP\-\-verbose\fR +Print extensive debug output to stderr. + + +.SH BUGS +Please report all bugs to CESNET gLite L&B issue tracker available at +.I https://github.com/CESNET/glite-lb/issues + + +.SH AUTHORS +L&B Product Team, CESNET. + + +.SH SEE ALSO +\fBglite-lb-dump_exporter\fP(1), \fBglite-lb-purge\fP(1), README.LB-statistics diff --git a/org.glite.lb.utils/project/glite-lb-utils.spec b/org.glite.lb.utils/project/glite-lb-utils.spec index 2332850..dfc9b59 100644 --- a/org.glite.lb.utils/project/glite-lb-utils.spec +++ b/org.glite.lb.utils/project/glite-lb-utils.spec @@ -62,10 +62,7 @@ rm -rf $RPM_BUILD_ROOT %{_bindir}/glite-lb-purge %{_bindir}/glite-lb-state_history %{_bindir}/glite-lb-statistics -%{_mandir}/man1/glite-lb-mon.1* -%{_mandir}/man1/glite-lb-dump.1* -%{_mandir}/man1/glite-lb-load.1* -%{_mandir}/man1/glite-lb-purge.1* +%{_mandir}/man1/* %changelog