"Fossies" - the Fresh Open Source Software Archive

Member "SAOImageDS9/tcllib/apps/nns.man" (13 Nov 2019, 4301 Bytes) of package /linux/misc/ds9.8.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 [comment {-*- tcl -*- doctools manpage}]
    2 [manpage_begin nns n 1.1]
    3 [see_also nameserv(n)]
    4 [see_also nameserv::common(n)]
    5 [keywords application]
    6 [keywords client]
    7 [keywords {name service}]
    8 [copyright {2007-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
    9 [moddesc   {Name service facility}]
   10 [titledesc {Name service facility, Commandline Client Application}]
   11 [category  Networking]
   12 [description]
   13 [para]
   14 
   15 Please read [term {Name service facility, introduction}] first.
   16 
   17 [para]
   18 
   19 The application described by this document, [syscmd nns], is a simple
   20 command line client for the nano name service facility provided by the
   21 Tcllib packages [package nameserv], and [package nameserv::server].
   22 
   23 Beyond that the application's sources also serve as an example of how
   24 to use the client package [package nameserv]. All abilities of a
   25 client are covered, from configuration to registration of names to
   26 searching.
   27 
   28 [para]
   29 
   30 This name service facility has nothing to do with the Internet's
   31 [term {Domain Name System}], otherwise known as [term DNS]. If the
   32 reader is looking for a package dealing with that please see either of
   33 the packages [package dns] and [package resolv], both found in Tcllib
   34 too.
   35 
   36 [subsection {USE CASES}]
   37 
   38 [syscmd nns] was written with the following two main use cases in
   39 mind.
   40 
   41 [para]
   42 [list_begin enumerated]
   43 [enum]
   44 Registration of a name/data pair in the name service.
   45 
   46 [enum]
   47 Searching the name service for entries matching a glob pattern.
   48 
   49 [list_end]
   50 
   51 [para]
   52 
   53 Beyond the above we also want to be able to identify the client, and
   54 get information about the name service.
   55 
   56 [subsection {COMMAND LINE}]
   57 
   58 [list_begin definitions]
   59 
   60 [call [cmd nns] [method bind] \
   61 	[opt "[option -host] [arg host]"] \
   62 	[opt "[option -port] [arg port]"] \
   63 	[arg name] [arg data]]
   64 
   65 This form registers the [arg name]/[arg data] pair in the specified
   66 name service. In this form the command will [emph not] exit to keep
   67 the registration alive. The user has to kill it explicitly, either by
   68 sending a signal, or through the job-control facilities of the shell
   69 in use. It will especially survive the loss of the connection to the
   70 name service and reestablish the [arg name]/[arg data] pair when the
   71 connection is restored.
   72 
   73 [para]
   74 The options to specify the name service will be explained later, in
   75 section [sectref OPTIONS].
   76 
   77 [call [cmd nns] [method search] \
   78 	[opt "[option -host] [arg host]"] \
   79 	[opt "[option -port] [arg port]"] \
   80 	[opt [option -continuous]] \
   81 	[opt [arg pattern]]]
   82 
   83 This form searches the specified name service for entries matching the
   84 glob-[arg pattern] and prints them to stdout, with each entry on its
   85 own line. If no pattern is specified it defaults to [const *],
   86 matching everything.
   87 
   88 [para]
   89 The options to specify the name service will be explained later, in
   90 section [sectref OPTIONS].
   91 
   92 [para]
   93 
   94 If the option [option -continuous] is specified the client will not
   95 exit after performing the search, but start to continuously monitor
   96 the service for changes to the set of matching entries, appropriately
   97 updating the display as changes arrive. In that form it will
   98 especially also survive the loss of the connection to the name service
   99 and reestablish the search when the connection is restored.
  100 
  101 [call [cmd nns] [method ident] \
  102 	[opt "[option -host] [arg host]"] \
  103 	[opt "[option -port] [arg port]"]]
  104 
  105 This form asks the specified name service for the version and features
  106 of the name service protocol it supports and prints the results to
  107 stdout.
  108 
  109 [para]
  110 The options to specify the name service will be explained later, in
  111 section [sectref OPTIONS].
  112 
  113 [call [cmd nns] [method who]]
  114 
  115 This form prints name, version, and protocol version of the
  116 application to stdout.
  117 
  118 [list_end]
  119 
  120 [subsection OPTIONS]
  121 
  122 This section describes all the options available to the user of the
  123 application
  124 
  125 [para]
  126 [list_begin options]
  127 [opt_def -host name|ipaddress]
  128 
  129 If this option is not specified it defaults to [const localhost]. It
  130 specifies the name or ip-address of the host the name service to talk
  131 to is running on.
  132 
  133 [opt_def -port number]
  134 
  135 If this option is not specified it defaults to [const 38573]. It
  136 specifies the TCP port the name service to talk to is listening on for
  137 requests.
  138 
  139 [list_end]
  140 
  141 [vset CATEGORY nameserv]
  142 [include ../modules/doctools2base/include/feedback.inc]
  143 [manpage_end]