.\" --------------------------------------------------------------------------
.\"
.\"              //===//   //=====   //===//   //       //   //===//
.\"             //    //  //        //    //  //       //   //    //
.\"            //===//   //=====   //===//   //       //   //===<<
.\"           //   \\         //  //        //       //   //    //
.\"          //     \\  =====//  //        //=====  //   //===//   Version III
.\"
.\" ------------- An Efficient RSerPool Prototype Implementation -------------
.\"
.\" Copyright (C) 2002-2023 by Thomas Dreibholz
.\"
.\" This program is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.\"
.\" Contact: thomas.dreibholz@gmail.com
.\"
.\" ###### Setup ############################################################
.Dd June 06, 2012
.Dt HSDump 1
.Os Handlespace Dump
.\" ###### Name #############################################################
.Sh NAME
.Nm hsdump
.Nd Dumps the handlespace of a RSerPool Registrar.
.\" ###### Synopsis #########################################################
.Sh SYNOPSIS
.Nm hsdump
.Op Fl address:port
.Op Fl cspserver=address:port
.Op Fl cspinterval=milliseconds
.Op Fl logappend=filename
.Op Fl logcolor=on|off
.Op Fl logfile=filename
.Op Fl loglevel=0-9
.\" ###### Description ######################################################
.Sh DESCRIPTION
.Nm hsdump
dumps the handlespace of a Reliable Server Pooling (RSerPool) Registrar (PR).
For this purpose, it claims to be a peer registrar and requests the handlespace
via ENRP. Handle with care!
.Pp
.\" ###### Arguments ########################################################
.Sh ARGUMENTS
The following options are available:
.Bl -tag -width indent
.It address:port
The ENRP address and port of the target registrar.
.\" ====== Component Status Protocol ========================================
.It Component Status Protocol (CSP) Parameters:
.Bl -tag -width indent
.It Fl cspinterval=milliseconds
Sets the interval for the CSP status updates in milliseconds. By default, the
content of the environment variable CSP_INTERVAL is used. If not defined, no
CSP status reports will be sent.
.It Fl cspserver=address:port
Sets the address of a CSP monitor server. By default, the content of the
environment variable CSP_SERVER is used. If not defined, no CSP status reports
will be sent.
.El
.\" ====== Logging ==========================================================
.It Logging Parameters:
.Bl -tag -width indent
.It Fl logappend=filename
Write logging output to a file (default is stdout); output will be appended to given file.
.It Fl logcolor=on|off
Turns ANSI colorization of the logging output on or off.
.It Fl logfile=filename
Write logging output to a file (default is stdout); given file will be overwritten.
.It Fl loglevel=0-9
Sets the logging verbosity from 0 (none) to 9 (very verbose).
It is recommended to use at least a value of 2 to see possibly
important error messages and warnings.
.El
.El
.Pp
.\" ###### Environment ######################################################
.Sh ENVIRONMENT
.Nm hsdump
uses the environment variables CSP_SERVER and CSP_INTERVAL to define a CSP
server to send reports to in the specified interval.
.\" ###### Diagnostics ######################################################
.Sh DIAGNOSTICS
If loglevel>0, log messages will be printed to stdout or into a specified
log file.
.\" ###### See also #########################################################
.Sh SEE ALSO
For a detailed introduction to RSerPool, see:
.br
https://duepublico.uni-duisburg-essen.de/servlets/DerivateServlet/Derivate-16326/Dre2006_final.pdf
.Pp
Thomas Dreibholz's RSerPool Page:
.br
https://www.nntb.no/~dreibh/rserpool/