diff options
Diffstat (limited to 'vendor/voclient/doc/voclient.html')
| -rw-r--r-- | vendor/voclient/doc/voclient.html | 394 |
1 files changed, 394 insertions, 0 deletions
diff --git a/vendor/voclient/doc/voclient.html b/vendor/voclient/doc/voclient.html new file mode 100644 index 00000000..ec31de4b --- /dev/null +++ b/vendor/voclient/doc/voclient.html @@ -0,0 +1,394 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOCLIENT</TITLE> +</HEAD><BODY> +<H1>VOCLIENT</H1> +Section: User Commands (1)<BR>Updated: May 2013<BR><A HREF="#index">Index</A> +<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR> + +<A NAME="lbAB"> </A> +<H2>NAME</H2> + +VOClient - Virtual Observatory (VO) Libraries and Desktop Applications +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>VOClient</B> is a collection of programming APIs and +command-line tools that provide a user-ready VO software distribution for +both scientists and developers. The initial release of the package is +intended primarily to distribute the completed CLI tools, additional tasks +are planned as new functionality is added to the libraries and as new +standards come on-line in the VO. +<P> + +The VOClient package includes a number of command-line utilities +built from the underlying interfaces. These tasks can be scripted from any +number of environments or used in a standalone manner. Tasks distributed +in this release include: +<P> +<A NAME="lbAD"> </A> +<H2>Command-Line Tools</H2> + +<P> + +<B>Data Access Tools</B> + +<DL COMPACT> +<DT> +<I>voatlas<TT> </TT><TT> </TT></I> + +<DD>Query the SkyView Image service for an all-sky image<BR> +<DT> +<I>vocatalog<TT> </TT></I> + +<DD>Query VO catalog services for data<BR> +<DT> +<I>vodata<TT> </TT><TT> </TT></I> + +<DD>Query and access VO data services<BR> +<DT> +<I>voimage<TT> </TT><TT> </TT></I> + +<DD>Query VO image services for data<BR> +<DT> +<I>voiminfo<TT> </TT><TT> </TT></I> + +<DD>Print/Get information about a FITS file's structure<BR> +<DT> +<I>vospectra<TT> </TT></I> + +<DD>Query VO spectral services for data<BR> +<P> +</DL> +<P> + +<B>Utility Tools</B> + +<DL COMPACT> +<DT> +<I>voregistry<TT> </TT></I> + +<DD>VO Registry search client<BR> +<DT> +<I>vosesame<TT> </TT></I> + +<DD>Call the Sesame name resolver service<BR> +<DT> +<I>vosamp<TT> </TT><TT> </TT></I> + +<DD>Command-line SAMP tool<BR> +<P> +</DL> +<P> + +<B>VOTable Tools</B> + +<DL COMPACT> +<DT> +<I>votcnv<TT> </TT><TT> </TT></I> + +<DD>Convert from VOTable to another format<BR> +<DT> +<I>votget<TT> </TT><TT> </TT></I> + +<DD>Download URLs or access references in a VOTable<BR> +<DT> +<I>votinfo<TT> </TT><TT> </TT></I> + +<DD>Get information about a VOTable<BR> +<DT> +<I>votopic<TT> </TT><TT> </TT></I> + +<DD>Query data resources specified by topic keyword<BR> +<DT> +<I>votpos<TT> </TT><TT> </TT></I> + +<DD>Extract the main positional columns from a VOTable<BR> +<DT> +<I>votsort<TT> </TT><TT> </TT></I> + +<DD>Extract the main positional columns from a VOTable<BR> +<DT> +<I>votstat<TT> </TT><TT> </TT></I> + +<DD>Compute statistics for numeric columns of a VOTable.<BR> +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>Programming Interfaces</H2> + +<DL COMPACT> +<DT> +<I>libsamp</I> + +<DD>SAMP interface. This interface allows an application to send and receive +SAMP messages but does NOT (at this time) provide a local Hub implementation. +Applications can register their own functions to be used as callbacks in +response to a message, the API provides only the middle-ware needed to +handle the SAMP protocol. +<DT> +<I>libvoclient</I> + +<DD>Client-side VO interface. This interface uses the VOClient Daemon to access +a variety of VO web services (Registry, Sesame, DAL services, etc) which +then communicate to the API to pass information back to the application. +<DT> +<I>libvotable</I> + +<DD>VOTable parser interface. The interface provides both read (lax parsing) +and write (strict compliance) capabilities. Reference is VOTable v1.2. +<DT> +<I>libvoapps</I> + +<DD>VO Applications interface. High-level interface to application functionality. +Tasks are built on these routines to provide the cmdline user interface, +but are encapsulated in an API to provide this functionality to other +environments easily (as opposed to having that functionality +be re-implemented using the low-level interfaces). +<P> +</DL> +<A NAME="lbAF"> </A> +<H3>Dependency Libraries</H3> + +<DL COMPACT> +<DT> +<I>libcurl<TT> </TT><TT> </TT></I> + +<DD>SAMP interface<BR> +<DT> +<I>libcfitsio<TT> </TT><TT> </TT></I> + +<DD>C FITSIO interface<BR> +<DT> +<I>libexpat<TT> </TT><TT> </TT></I> + +<DD>XML parser<BR> +<DT> +<I>libxmlrpc-c<TT> </TT></I> + +<DD>XML-RPC interface<BR> +<P> +</DL> +<A NAME="lbAG"> </A> +<H2>INSTALLATION</H2> + +<P> + +<B>Using Pre-Built Binaries</B> + +<P> + +Pre-built binary distributions are available containg both source and +binaries for a specific platform. These distribution names are of the form +<PRE> +<DL COMPACT><DT><DD> + <I>voclient-<version>-bin.<arch>.tar.gz</I> +</DL> +</PRE> + +<P> + +where <I><arch></I> is one of +<DL COMPACT><DT><DD> +<DL COMPACT> +<DT> +<I>linux<TT> </TT></I> + +<DD>32-bit Linux systems (Fedora, Ubuntu, Debian, etc).<BR> +<DT> +<I>linux64<TT> </TT></I> + +<DD>64-bit Linux systems (Fedora, Ubuntu, Debian, etc).<BR> +<DT> +<I>macosx<TT> </TT></I> + +<DD>32-bit OSX 10.6 and higher systems for Mac.<BR> +<DT> +<I>macintel<TT> </TT></I> + +<DD>64-bit OSX 10.6 and higher systems for Mac.<BR> +</DL> +</DL> + +<P> +<P> + +The distribution file may be unpacked with the command +<PRE> +<DL COMPACT><DT><DD> +tar zxf /<I><path></I>/voclient-<I><version></I>-bin.<I><arch></I>.tar.gz + +</DL> +</PRE> + +<P> + +This will produce a '<I>voclient</I>' subdirectory containing the unpacked +distribution. Within that directory you'll find the following important +directories needed to install the package on the system: +<P> +<DL COMPACT> +<DT> +<I>bin/ </I> + +<DD>Task binaries +<DT> +<I>lib/ </I> + +<DD>API library files +<DT> +<I>include/ </I> + +<DD>Program header files +<P> +</DL> +<P> + +The contents of these directories should be copied to some system directory +available in the normal user paths. For example, to install in /usr/local +<PRE> +<DL COMPACT><DT><DD> +% cd /<path>/voclient +% sudo cp bin/* /usr/local/bin +% sudo cp lib/* /usr/local/lib +% sudo cp include/* /usr/local/include +</DL> +</PRE> + +<P> + +When compiling new applications the appropriate '-I' and '-L' flags will +need to be set to find the libraries and include files needed. The binary +installation directory should be some directory in the normal $PATH +environment setting. +<P> +<B>Building VOClient from Source</B> + +<P> + +The source distribution of the release is containe in the file +<PRE> +<DL COMPACT><DT><DD> +<I>voclient-src.tar.gz</I> + +</DL> +</PRE> + +<P> + +It may be unpacked with the command +<PRE> +<DL COMPACT><DT><DD> +<I>tar zxf /<path>/voclient-src.tar.gz</I> + +</DL> +</PRE> + +<P> + +This will produce a 'voclient' subdirectory containing the unpacked +distribution. Utility scripts are used throughout the system to do the +platform configuration necessary, therefore the only command needed to +build the package is: +<PRE> +<DL COMPACT><DT><DD>% cd /<path>/voclient +% make +</DL> +</PRE> + +<P> + +As with the pre-built binary described above, the following important +directories are needed to install the package on the system: +<PRE> +<DL COMPACT><DT><DD> +bin/ Task binaries +lib/ API library files +include/ Program header files +</DL> +</PRE> + +<P> +<P> + +In a successful build the libraries and binaries are installed in the +package 'bin' and 'lib' directories, header files needed for program +development are put in the 'include' directory. The contents of these +directories should be copied to some system directory available in the +normal user paths. For example, to install in /usr/local +<PRE> +<DL COMPACT><DT><DD>% cd /<path>/voclient +% sudo cp bin/* /usr/local/bin +% sudo cp lib/* /usr/local/lib +% sudo cp include/* /usr/local/include +</DL> +</PRE> + +<P> + +When compiling new applications the appropriate '-I' and '-L' flags will +need to be set to find the libraries and include files needed. The binary +installation directory should be some directory in the normal $PATH +environment setting. +<P> +<B>Supported Platforms</B> + +<P> + +This release currently supports the following platforms: +<PRE> +<DL COMPACT><DT><DD> + Mac OSX 32-bit and 64-bit Intel, OSX 10.6 and later + Linux 32-bit 32-bit Linux systems (Fedora, Redhat, Ubuntu, etc) + Linux 64-bit 64-bit Linux systems (Fedora, Redhat, Ubuntu, etc) +</DL> +</PRE> + +<P> + +Additional platforms will be added as needed. +<P> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +This is the first public release +<A NAME="lbAI"> </A> +<H2>REVISION HISTORY</H2> + +May 2013 - First public release +<A NAME="lbAJ"> </A> +<H2>AUTHOR</H2> + +Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), May 2013 +<A NAME="lbAK"> </A> +<H2>SEE ALSO</H2> + +voatlas, vocatalog, vodata, voimage, votiminfo, voregistry, vosesame, vospectra, votcnv, votget, votinfo, votopic, votpos, votsort, votstat, vosamp +<P> + +<HR> +<A NAME="index"> </A><H2>Index</H2> +<DL> +<DT><A HREF="#lbAB">NAME</A><DD> +<DT><A HREF="#lbAC">SYNOPSIS</A><DD> +<DT><A HREF="#lbAD">Command-Line Tools</A><DD> +<DT><A HREF="#lbAE">Programming Interfaces</A><DD> +<DL> +<DT><A HREF="#lbAF">Dependency Libraries</A><DD> +</DL> +<DT><A HREF="#lbAG">INSTALLATION</A><DD> +<DT><A HREF="#lbAH">BUGS</A><DD> +<DT><A HREF="#lbAI">REVISION HISTORY</A><DD> +<DT><A HREF="#lbAJ">AUTHOR</A><DD> +<DT><A HREF="#lbAK">SEE ALSO</A><DD> +</DL> +<HR> +This document was created by +<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>, +using the manual pages.<BR> +Time: 04:49:15 GMT, May 24, 2013 + +</BODY> +</HTML> + |