From c9e99901355383765ff6613d770f016e700acfbf Mon Sep 17 00:00:00 2001 From: =?utf8?q?Franti=C5=A1ek=20Dvo=C5=99=C3=A1k?= Date: Tue, 21 Feb 2006 20:18:22 +0000 Subject: [PATCH] Documentation for client interface for JP IS. --- org.glite.jp.index/Makefile | 23 +++- org.glite.jp.index/doc/glite-jpis-client.sgml | 186 ++++++++++++++++++++++++++ 2 files changed, 205 insertions(+), 4 deletions(-) create mode 100644 org.glite.jp.index/doc/glite-jpis-client.sgml diff --git a/org.glite.jp.index/Makefile b/org.glite.jp.index/Makefile index 599f060..c0324e3 100644 --- a/org.glite.jp.index/Makefile +++ b/org.glite.jp.index/Makefile @@ -22,7 +22,7 @@ CC=gcc -include Makefile.inc -VPATH=${top_srcdir}/src:${top_srcdir}/examples:${top_srcdir}/tests:${top_srcdir}/test:${top_srcdir}/project:${jpproject}:${stagedir}/interface +VPATH=${top_srcdir}/src:${top_srcdir}/examples:${top_srcdir}/tests:${top_srcdir}/test:${top_srcdir}/project:${top_srcdir}/doc:${jpproject}:${stagedir}/interface GLOBUS_LIBS:=-L${globus_prefix}/lib \ -lglobus_common_${nothrflavour} \ @@ -50,6 +50,10 @@ daemon:=glite-jp-indexd examples:=glite-jpis-test glite-jpis-client test:=run-test.sh test_files:=dump1.sql simple_query.in simple_query.out complex_query.in complex_query.out authz.out +MANS1:=glite-jpis-client.1 +MANS8:= +MANS:=${MANS1} ${MANS8} +HTMLS:=glite-jpis-client.html is_prefix:=jpis_ is_client_prefix:=jpis_client_ ps_prefix:=jpps_ @@ -75,7 +79,7 @@ SRVCOMMONLIB:=-lglite_jp_server_common BONESLIB:=-lglite_lb_server_bones TRIOLIB:=-lglite_jp_trio -default all: compile +default all: compile doc compile: ${daemon} ${examples} copy_tests @@ -136,7 +140,7 @@ ${ps_prefix}C.c ${ps_prefix}H.h ${ps_prefix}_Stub.h: JobProvenancePS.xh check: # ../test/run-test.sh -doc: +doc: ${MANS} ${HTMLS} stage: compile ${MAKE} PREFIX=${stagedir} DOSTAGE=yes install @@ -162,7 +166,9 @@ install: ${INSTALL} -m 755 ${examples} ${PREFIX}/examples ${INSTALL} -m 755 ${top_srcdir}/config/startup ${PREFIX}/etc/init.d/glite-jp-indexd ${INSTALL} -m 755 ${top_srcdir}/config/glite-jp-index-dbsetup.sql ${PREFIX}/etc - ${INSTALL} -m 644 ${top_srcdir}/doc/README ${PREFIX}/share/doc/${package}-${version} + ${INSTALL} -m 644 ${top_srcdir}/doc/README ${HTMLS} ${PREFIX}/share/doc/${package}-${version} + ${INSTALL} -m 644 ${MANS1} ${PREFIX}/share/man/man1 +# ${INSTALL} -m 644 ${MANS8} ${PREFIX}/share/man/man8 ${INSTALL} -m 755 ${test} ${PREFIX}/examples ${INSTALL} -m 644 ${test_files} ${PREFIX}/examples ${INSTALL} -m 644 ${top_srcdir}/interface/JobProvenanceISClient.xsd ${PREFIX}/interface @@ -189,4 +195,13 @@ ws_is_typeref.o: ws_is_typeref.c jpis_H.h ws_typemap.h ws_is_typeref.h comon_server.o: common_server.c common_server.h jpis-client.o: jpis-client.c ${is_client_prefix}H.h soap_version.h +%.1: %.sgml + docbook2man $< + +%.8: %.sgml + docbook2man $< + +%.html: %.sgml + docbook2html $< --nochunks + .PHONY: default all compile check doc stage dist distsrc distbin install clean diff --git a/org.glite.jp.index/doc/glite-jpis-client.sgml b/org.glite.jp.index/doc/glite-jpis-client.sgml new file mode 100644 index 0000000..fb6d8ba --- /dev/null +++ b/org.glite.jp.index/doc/glite-jpis-client.sgml @@ -0,0 +1,186 @@ + + + + + glite-jpis-client + 1 + + + + glite-jpis-client + client interface for JP IS + + + + + glite-jpis-client + + + -h + --help + + + + -i + --index-server + JPIS:PORT + + + -q + --query-file + IN_FILE.XML + + + -t + --test-file + IN_FILE.XML + + + -e + --example-file + OUT_FILE.XML + + + -f + --format + + xml + human + + + + + + + DESCRIPTION + +glite-jpis-client is command line interface for querying +the Job Provenance Index Server. It takes the XML input, process the QueryJobs +operation and returns the result in specified format. + + + + + OPTIONS + + +With no options you get simple usage message as with . + + + + + | + +Displays usage message. + + + + + | + +Specifies Job Provenance Index Server as HOST:PORT. + + + + + | + +Process the QueryJobs operation. Requires input data in file +IN_FILE.XML, for using stdin specify +. + +The input and output data are in XML format with XSD schema, which can be found +in JobProvenanceISClient.xsd (element QueryJobs for input +and QueryJobsResponse for output). + + + + + | + +Test the input data from IN_FILE.XML (or from stdin +if is specified) and prints the found content. + + + + + | + +Write the example input data to file OUT_FILE.XML +(or to stdout if is specified). The XML is valid against XSD +schema in JobProvananceISClient.xsd, formating may vary +according to used gsoap version. + + + + + | + +Use FORMAT as output format type. You can specify + for interchangeable XML output or +for nice looking human readable output. + + + + + + + RETURN VALUE + + + 0 + Success. + + + + -1 + Communication error or error from the remote server. + + + + EINVAL + In most cases XML parsing error. + + + + other error + Other error from errno. + + + + + + EXAMPLES + + + glite-jpis-client --example-file query.xml + +Save the example query parameters to file query.xml. + + + + + glite-jpis-client --query-file query.xml + +Queries the local index server running on default port with the query +parameters specified in the file query.xml. + + + + + glite-jpis-client -i localhost:8902 -q - -f human + +Queries the index server running on local host on the port 8902 with the query +parameters from stdin and show results in non-XML form. + + + + + + + + SEE ALSO + glite-jp-indexd(8) + + + -- 1.8.2.3