summaryrefslogtreecommitdiff
path: root/ACE/debian/tao_nslist.sgml
blob: 83790968b391f3ce790da9bcf24fa5026c61bdd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!ENTITY applname "tao_nslist">
  <!ENTITY man_tao_orb_options "<citerefentry><refentrytitle>TAO_ORB_Options</refentrytitle><manvolnum>1</manvolnum></citerefentry>">
  <!ENTITY man_tao_cosnaming "<citerefentry><refentrytitle>tao_cosnaming</refentrytitle><manvolnum>1</manvolnum></citerefentry>">
  <!ENTITY tao_cosnaming "<application>tao_cosnaming</application>">
  <!ENTITY man_tao_nsdel "<citerefentry><refentrytitle>tao_nsdel</refentrytitle><manvolnum>1</manvolnum></citerefentry>">
  <!ENTITY man_tao_nsadd "<citerefentry><refentrytitle>tao_nsadd</refentrytitle><manvolnum>1</manvolnum></citerefentry>">
  <!ENTITY seealso "&man_tao_orb_options;, &man_tao_cosnaming;, &man_tao_nsadd;, &man_tao_nsdel;">
]>
<!-- This file was written by Marek Brudka <mbrudka@aster.pl>   -->
<!-- on September 2010 for the Debian GNU/Linux operating system.             -->
<!-- It is mainly a plain text to DocBook conversion of the USAGE file. -->

<refentry>
  <refmeta>
    <refentrytitle>TAO_NSLIST</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&applname;</refname>
    <refpurpose>Naming Service listing utility.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>SYNOPSIS</title>
    <cmdsynopsis>
      <command>&applname;</command>
      <group><arg>-ORBoptions</arg></group>
      <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      &applname; lists the current entries in the NamingService; in a nicely formatted manner.
    </para>
    <para>
      When invoked without arguments &applname; displays the contents of the default NamingService,
      including the protocol and endpoint of each object reference.
    </para>    
    <para>
     &applname; requires a running NamingService.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
      <variablelist>
      <varlistentry>
	<term><parameter>-ORBoptions</parameter></term>
	<listitem>
	  <para>
	    The program follows the usual TAO ORB command line syntax. See
	    &man_tao_orb_options;.
	  </para>
      </listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter>--nsior</parameter></term>
	<listitem>
	  <para>
	  Display the naming service IOR and exit. This can be used to locate the TAO NameService for non-TAO applications and excludes using any other options.
	  </para>	
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--ns</parameter> <replaceable>IOR</replaceable> </term>
	<listitem>
	  <para>	  
	  Use given <replaceable>IOR</replaceable> for NamingService.
	  </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--ior</parameter></term>
	<listitem>
	  <para>
	  Print the contents of the NamingService, including the IOR of each
	  reference entry and the IOR of the NameService itself.
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--ctxior</parameter></term>
	<listitem>
	  <para>
	  Print additionally the IORs of any subcontexts found within NamingService.
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--tree</parameter> <replaceable>character</replaceable></term>
	<listitem>
	  <para>
	  Print tree of object registered in NamingService using <replaceable>character</replaceable> for drawing tramlines, defaults to "|" .
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--node</parameter> <replaceable>character</replaceable></term>
	<listitem>
	  <para>
	  Print tree of object registered in NamingService using <replaceable>character</replaceable> for drawing nodes, defaults to "+" .
	  </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--noloops</parameter></term>
	<listitem>
	  <para>
	  Inhibit drawing of naming context loops.
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--name</parameter> <replaceable>name</replaceable></term>
	<listitem>
	  <para>
	  Lists sub-set of <replaceable>name</replaceable>, defaults to root.
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--ctxsep</parameter> <replaceable>character</replaceable></term>
	<listitem>
	  <para>
	  Set context separation <replaceable>character</replaceable>, defaults to "/".
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--kindsep</parameter> <replaceable>character</replaceable></term>
	<listitem>
	  <para>
	  Set ID/Kind separation <replaceable>character</replaceable>, defaults to ".".
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--max</parameter> <replaceable>number</replaceable></term>
	<listitem>
	  <para>
	  Set limit of displayed sub-context depth to <replaceable>number</replaceable>.
         </para>
	</listitem>
	</varlistentry>
	<varlistentry>
	<term><parameter>--rtt</parameter> <replaceable>seconds</replaceable></term>
	<listitem>
	  <para>
	  Set the relative round trip timeout policy to <replaceable>seconds</replaceable>.
         </para>
	</listitem>
	</varlistentry>

      </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>&seealso;</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>Thomas Lockhart<email>&lt;Thomas.Lockhart@jpl.nasa.gov&gt;</email> </para>
    <para>Simon Massey <email>&lt;sma@prismtech.com&gt;</email> </para>
  </refsect1>
</refentry>