commit 67d879a7d47e315e258d5c3d2b481e765872962e Author: František Dvořák Date: Wed Jan 8 13:55:55 2014 +0100 Change man pages section of purge, dump, and load from 8 to 1. Let's the binaries kept in /usr/bin (http://www.pathname.com/fhs/pub/fhs-2.3.html, footnote [19]). diff --git a/org.glite.lb.utils/Makefile b/org.glite.lb.utils/Makefile index 6bfb52f..a94e86e 100644 --- a/org.glite.lb.utils/Makefile +++ b/org.glite.lb.utils/Makefile @@ -21,7 +21,7 @@ docdir?=${prefix}/share/doc/${package}-${version} VPATH=${top_srcdir}/src:${top_srcdir}/doc SOURCES=\ - doc/*.1 doc/*.8 doc/README.* \ + doc/*.1 doc/README.* \ examples/glite-lb-* \ src/*.c src/*.c.T src/*.sh \ Makefile @@ -78,12 +78,10 @@ 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-mon.1.gz -MAN8_GZ:=glite-lb-dump.8.gz glite-lb-load.8.gz glite-lb-purge.8.gz +MAN_GZ:=glite-lb-dump.1.gz glite-lb-load.1.gz glite-lb-purge.1.gz glite-lb-mon.1.gz MAN = $(MAN_GZ:.gz=) -MAN8 = $(MAN8_GZ:.gz=) -compile all: ${ALLUTILS} ${MAN_GZ} ${MAN8_GZ} +compile all: ${ALLUTILS} ${MAN_GZ} ${UTILS}: %: %.o ${LINK} -o $@ $< ${COMMON_LIB} ${CLIENT_LIB} ${EXT_LIBS} -lglite_lbu_maildir @@ -102,14 +100,11 @@ state_history: state_history.o check: compile -doc: ${MAN_GZ} ${MAN8_GZ} +doc: ${MAN_GZ} %.1.gz: %.1 gzip -9 -f -c $< > $@ -%.8.gz: %.8 - gzip -9 -f -c $< > $@ - stage: compile $(MAKE) install PREFIX=${stagedir} DOSTAGE=yes @@ -117,10 +112,8 @@ install: -mkdir -p ${DESTDIR}${PREFIX}${prefix}/bin -mkdir -p ${DESTDIR}${PREFIX}${docdir} -mkdir -p ${DESTDIR}${PREFIX}${prefix}/share/man/man1 - -mkdir -p ${DESTDIR}${PREFIX}${prefix}/share/man/man8 ${INSTALL} -m 644 ${top_srcdir}/doc/README* ${DESTDIR}${PREFIX}${docdir} ${INSTALL} -m 644 ${MAN_GZ} ${DESTDIR}${PREFIX}${prefix}/share/man/man1 - ${INSTALL} -m 644 ${MAN8_GZ} ${DESTDIR}${PREFIX}${prefix}/share/man/man8 ${INSTALL} -m 755 ${top_srcdir}/src/glite-lb-bkpurge-offline.sh ${DESTDIR}${PREFIX}${prefix}/bin/glite-lb-bkpurge-offline for p in ${ALLUTILS} ; do \ @@ -128,7 +121,7 @@ install: done clean: - rm -rfv ${ALLUTILS} ${MAN_GZ} ${MAN8_GZ} *.lo *.o .libs/ + rm -rfv ${ALLUTILS} ${MAN_GZ} *.lo *.o .libs/ rm -rvf dist ${package}-*.tar.gz distclean: diff --git a/org.glite.lb.utils/doc/glite-lb-dump.1 b/org.glite.lb.utils/doc/glite-lb-dump.1 new file mode 100644 index 0000000..0e8d313 --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-dump.1 @@ -0,0 +1,62 @@ +.TH GLITE-LB-DUMP 1 "April 2008" "EGEE Project" "Logging&Bookkeeping" + +.SH NAME +glite-lb-dump - utility for dumping job events from L&B database + +.SH SYNOPSIS +.B glite-lb-dump +.RI [ options ] +.br + +.SH DESCRIPTION +.B glite-lb-dump +is utility for dumping job events from L&B database. It is primarilly used for statistical purposes. By default, it dumps events from the time when the last dum ended upto now. + +.B glite-lb-dump +may be run periodically, however the periodic dumps are done by server itself, so check the configuration of the server first. + +.SH OPTIONS +.TP +.BI \-m \fR,\fP --server mkserver +L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is beeing checked. + +.TP +.BI \-f \fR,\fP --from YYYYMMDDHHmmss +Beginning of the time interval for events to be dumped. + +.TP +.BI \-t \fR,\fP --to YYYYMMDDHHmmss +End of the time interval for events to be dumped. + +.TP +.BI \-h \fR,\fP --help +Display help. + +.TP +.BI \-v \fR,\fP --version +Display version. + +.TP +.B "-d\fR,\fP --debug" +Print diagnostics on the +.I stderr\fR.\fP + +.\".SH USAGE +.\" Add any additional description here + +.PP + +.SH FILES +No configuration files needed. + +.SH ENVIRONMENT +No environment variables needed. + +.SH REPORTING BUGS +Please, report all bugs to EGEE Bug Tracking System located at https://savannah.cern.ch + +.SH SEE ALSO +.B glite-lb-bkindex\fR(8),\fP glite-lb-bkserverd\fR(8),\fP glite-lb-interlogd\fR(8),\fP glite-lb-logd\fR(8),\fP glite-lb-logevent\fR(1),\fP + +.SH AUTHOR +EU EGEE, JRA1. diff --git a/org.glite.lb.utils/doc/glite-lb-dump.8 b/org.glite.lb.utils/doc/glite-lb-dump.8 deleted file mode 100644 index aa2b6fe..0000000 --- a/org.glite.lb.utils/doc/glite-lb-dump.8 +++ /dev/null @@ -1,62 +0,0 @@ -.TH GLITE-LB-DUMP 8 "April 2008" "EGEE Project" "Logging&Bookkeeping" - -.SH NAME -glite-lb-dump - utility for dumping job events from L&B database - -.SH SYNOPSIS -.B glite-lb-dump -.RI [ options ] -.br - -.SH DESCRIPTION -.B glite-lb-dump -is utility for dumping job events from L&B database. It is primarilly used for statistical purposes. By default, it dumps events from the time when the last dum ended upto now. - -.B glite-lb-dump -may be run periodically, however the periodic dumps are done by server itself, so check the configuration of the server first. - -.SH OPTIONS -.TP -.BI \-m \fR,\fP --server mkserver -L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is beeing checked. - -.TP -.BI \-f \fR,\fP --from YYYYMMDDHHmmss -Beginning of the time interval for events to be dumped. - -.TP -.BI \-t \fR,\fP --to YYYYMMDDHHmmss -End of the time interval for events to be dumped. - -.TP -.BI \-h \fR,\fP --help -Display help. - -.TP -.BI \-v \fR,\fP --version -Display version. - -.TP -.B "-d\fR,\fP --debug" -Print diagnostics on the -.I stderr\fR.\fP - -.\".SH USAGE -.\" Add any additional description here - -.PP - -.SH FILES -No configuration files needed. - -.SH ENVIRONMENT -No environment variables needed. - -.SH REPORTING BUGS -Please, report all bugs to EGEE Bug Tracking System located at https://savannah.cern.ch - -.SH SEE ALSO -.B glite-lb-bkindex\fR(8),\fP glite-lb-bkserverd\fR(8),\fP glite-lb-interlogd\fR(8),\fP glite-lb-logd\fR(8),\fP glite-lb-logevent\fR(1),\fP - -.SH AUTHOR -EU EGEE, JRA1. diff --git a/org.glite.lb.utils/doc/glite-lb-load.1 b/org.glite.lb.utils/doc/glite-lb-load.1 new file mode 100644 index 0000000..8cf0cc2 --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-load.1 @@ -0,0 +1,50 @@ +.TH GLITE-LB-LOAD 1 "April 2008" "EGEE Project" "Logging&Bookkeeping" + +.SH NAME +glite-lb-load - utility for loading job events into the L&B database + +.SH SYNOPSIS +.B glite-lb-load +.RI [ options ] +.br + +.SH DESCRIPTION +.B glite-lb-load +is utility for loading job events into the L&B database. It is primarilly used for recovery purposes. By default, it loads events from the last dump. + +.SH OPTIONS +.IP "\-m, --server \fIbkserver\fR" +L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is beeing checked. + +.IP "\-f, --file \fIfilename\fR" +File with dumped data to be loaded. + +.IP "\-h, --help" +Display help. + +.IP "\-v, --version" +Display version. + +.IP "\-d, --debug" +Print diagnostics on the +.I stderr\fR.\fP + +.\".SH USAGE +.\" Add any additional description here + +.PP + +.SH FILES +No configuration files needed. + +.SH ENVIRONMENT +No environment variables needed. + +.SH REPORTING BUGS +Please, report all bugs to EGEE Bug Tracking System located at https://savannah.cern.ch + +.SH SEE ALSO +.B glite-lb-bkindex\fR(8),\fP glite-lb-bkserverd\fR(8),\fP glite-lb-dump\fR(1),\fP glite-lb-purge\fR(1),\fP + +.SH AUTHOR +EU EGEE, JRA1. diff --git a/org.glite.lb.utils/doc/glite-lb-load.8 b/org.glite.lb.utils/doc/glite-lb-load.8 deleted file mode 100644 index 40509d7..0000000 --- a/org.glite.lb.utils/doc/glite-lb-load.8 +++ /dev/null @@ -1,50 +0,0 @@ -.TH GLITE-LB-LOAD 8 "April 2008" "EGEE Project" "Logging&Bookkeeping" - -.SH NAME -glite-lb-load - utility for loading job events into the L&B database - -.SH SYNOPSIS -.B glite-lb-load -.RI [ options ] -.br - -.SH DESCRIPTION -.B glite-lb-load -is utility for loading job events into the L&B database. It is primarilly used for recovery purposes. By default, it loads events from the last dump. - -.SH OPTIONS -.IP "\-m, --server \fIbkserver\fR" -L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is beeing checked. - -.IP "\-f, --file \fIfilename\fR" -File with dumped data to be loaded. - -.IP "\-h, --help" -Display help. - -.IP "\-v, --version" -Display version. - -.IP "\-d, --debug" -Print diagnostics on the -.I stderr\fR.\fP - -.\".SH USAGE -.\" Add any additional description here - -.PP - -.SH FILES -No configuration files needed. - -.SH ENVIRONMENT -No environment variables needed. - -.SH REPORTING BUGS -Please, report all bugs to EGEE Bug Tracking System located at https://savannah.cern.ch - -.SH SEE ALSO -.B glite-lb-bkindex\fR(8),\fP glite-lb-bkserverd\fR(8),\fP glite-lb-dump\fR(8),\fP glite-lb-purge\fR(8),\fP - -.SH AUTHOR -EU EGEE, JRA1. diff --git a/org.glite.lb.utils/doc/glite-lb-purge.1 b/org.glite.lb.utils/doc/glite-lb-purge.1 new file mode 100644 index 0000000..d51a920 --- /dev/null +++ b/org.glite.lb.utils/doc/glite-lb-purge.1 @@ -0,0 +1,103 @@ +.TH GLITE-LB-PURGE 1 "April 2008" "EGEE Project" "Logging&Bookkeeping" + + +.SH NAME +glite-lb-purge - utility for removing inactive jobs from the L&B database + + +.SH SYNOPSIS +.B glite-lb-purge +.RI [ options ] +.br + + +.SH DESCRIPTION +.B glite-lb-purge +is utility for removing inactive jobs from the L&B database. By default, it removes jobs that reached CLEARED, ABORTED and CANCELLED state and also OTHER jobs that are in another state and are inactive for specific (rather long) time. It is a command line frontend to server internal purge. It is used by administrators of bkserver and it is not supposed to be used at the user level. + +.B glite-lb-purge +may be run periodically in order to avoid database overflow, however the periodic purges are done by server itself, so check the configuration of the server first. + + +.SH OPTIONS +.IP "-m, --server \fIbkserver\fR" +L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is beeing checked. + +.IP "-a, --aborted \fiNNN[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. + +.IP "-c, --cleared \fiNNN[smhd]\fR" +Purge CLEARED jobs older than given time. + +.IP "-n, --cancelled \fiNNN[smhd]\fR" +Purge CANCELLED jobs older than given time. + +.IP "-e, --done \fiNNN[smhd]\fR" +Purge DONE jobs older than given time. + +.IP "-o, --other \fiNNN[smhd]\fR" +Purge OTHER (i.e. job in other state than ABORTED, CLEARED or CANCELLED) jobs older than given time. + +.IP "-r, --dry-run" +Do not really purge. + +.IP "-j, --jobs \fIfilename\fR" +Input file with jobIds of jobs to purge. + +.IP "-l, --return-list" +Return list of jobid matching the purge/dump criteria. + +.IP "-s, --server-dump" +Dump jobs at the server into a file (see bkserverd). + +.IP "-i, --client-dump" +Receive stream of dumped jobs (NOT implemented yet!). + +.IP "-h, --help" +Display help. + +.IP "-v, --version" +Display version. + +.IP "-d, --debug" +Print diagnostics on the \fIstderr\fR. + +.IP "-x, --proxy" +Purge L&B proxy. + +.IP "-X, --sock \fIpath\fR" +Purge L&B proxy using given socket path. + +.IP "-t, --target-runtime \fiNNN[smhd]\fR" +Throttle purge to the estimated target runtime. + +.IP "-b, --background \fiN\fR" +Purge on the background. Default 1 when throttled purging. + + +.\".SH EXAMPLES +.\"To appear :o( + + +.SH FILES +No configuration files needed. + + +.SH ENVIRONMENT +.TP +.B EDG_WL_QUERY_SERVER +If +.RB $ EDG_WL_QUERY_SERVER +is set, its value is used as the bkserver address. + + +.SH REPORTING BUGS +Please, report all bugs to EGEE Bug Tracking System located at https://savannah.cern.ch + + +.SH SEE ALSO +\fBglite-lb-bkindex\fP(8), \fBglite-lb-bkserverd\fP(8), \fBglite-lb-interlogd\fP(8), \fBglite-lb-logd\fP(8), \fBglite-lb-logevent\fP(1), \fBglite-lb-dump\fP(1), \fBglite-lb-load\fP(1) + + +.SH AUTHOR +EU EGEE, JRA1. diff --git a/org.glite.lb.utils/doc/glite-lb-purge.8 b/org.glite.lb.utils/doc/glite-lb-purge.8 deleted file mode 100644 index 4482ba0..0000000 --- a/org.glite.lb.utils/doc/glite-lb-purge.8 +++ /dev/null @@ -1,103 +0,0 @@ -.TH GLITE-LB-PURGE 8 "April 2008" "EGEE Project" "Logging&Bookkeeping" - - -.SH NAME -glite-lb-purge - utility for removing inactive jobs from the L&B database - - -.SH SYNOPSIS -.B glite-lb-purge -.RI [ options ] -.br - - -.SH DESCRIPTION -.B glite-lb-purge -is utility for removing inactive jobs from the L&B database. By default, it removes jobs that reached CLEARED, ABORTED and CANCELLED state and also OTHER jobs that are in another state and are inactive for specific (rather long) time. It is a command line frontend to server internal purge. It is used by administrators of bkserver and it is not supposed to be used at the user level. - -.B glite-lb-purge -may be run periodically in order to avoid database overflow, however the periodic purges are done by server itself, so check the configuration of the server first. - - -.SH OPTIONS -.IP "-m, --server \fIbkserver\fR" -L&B server machine name. If not specified, the environment variable EDG_WL_QUERY_SERVER is beeing checked. - -.IP "-a, --aborted \fiNNN[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. - -.IP "-c, --cleared \fiNNN[smhd]\fR" -Purge CLEARED jobs older than given time. - -.IP "-n, --cancelled \fiNNN[smhd]\fR" -Purge CANCELLED jobs older than given time. - -.IP "-e, --done \fiNNN[smhd]\fR" -Purge DONE jobs older than given time. - -.IP "-o, --other \fiNNN[smhd]\fR" -Purge OTHER (i.e. job in other state than ABORTED, CLEARED or CANCELLED) jobs older than given time. - -.IP "-r, --dry-run" -Do not really purge. - -.IP "-j, --jobs \fIfilename\fR" -Input file with jobIds of jobs to purge. - -.IP "-l, --return-list" -Return list of jobid matching the purge/dump criteria. - -.IP "-s, --server-dump" -Dump jobs at the server into a file (see bkserverd). - -.IP "-i, --client-dump" -Receive stream of dumped jobs (NOT implemented yet!). - -.IP "-h, --help" -Display help. - -.IP "-v, --version" -Display version. - -.IP "-d, --debug" -Print diagnostics on the \fIstderr\fR. - -.IP "-x, --proxy" -Purge L&B proxy. - -.IP "-X, --sock \fIpath\fR" -Purge L&B proxy using given socket path. - -.IP "-t, --target-runtime \fiNNN[smhd]\fR" -Throttle purge to the estimated target runtime. - -.IP "-b, --background \fiN\fR" -Purge on the background. Default 1 when throttled purging. - - -.\".SH EXAMPLES -.\"To appear :o( - - -.SH FILES -No configuration files needed. - - -.SH ENVIRONMENT -.TP -.B EDG_WL_QUERY_SERVER -If -.RB $ EDG_WL_QUERY_SERVER -is set, its value is used as the bkserver address. - - -.SH REPORTING BUGS -Please, report all bugs to EGEE Bug Tracking System located at https://savannah.cern.ch - - -.SH SEE ALSO -\fBglite-lb-bkindex\fP(8), \fBglite-lb-bkserverd\fP(8), \fBglite-lb-interlogd\fP(8), \fBglite-lb-logd\fP(8), \fBglite-lb-logevent\fP(1), \fBglite-lb-dump\fP(8), \fBglite-lb-load\fP(8) - - -.SH AUTHOR -EU EGEE, JRA1.