usr/src/doc/manpage/man-rad.xml
author David Powell <david.e.powell@oracle.com>
Tue, 02 Nov 2010 17:04:46 -0700
changeset 595 725a82f60b1c
parent 587 7093024d532b
child 664 bf20f6a9e353
permissions -rw-r--r--
17332 support loading specific modules
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     1
<?xml version="1.0" encoding="UTF-8"?>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     3
<!--
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     4
	PDL HEADER START
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     5
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     6
	Public Documentation License Notice
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     7
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     8
	The contents of this Documentation are subject to the Public
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     9
	Documentation License Version 1.01 (the "License"); you may only
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    10
	use this Documentation if you comply with the terms of this License.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    11
	A copy of the License is available at
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    12
	http://www.opensolaris.org/os/community/documentation/license.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    13
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    14
	PDL HEADER END
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    15
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    16
	Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    17
-->
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    18
587
7093024d532b 17210 Begin a developer guide
David Powell <david.e.powell@oracle.com>
parents: 585
diff changeset
    19
<refentry id="man.rad">
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    20
    <refentryinfo>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    21
	<date>March 24, 2010</date>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    22
	<productname>SunOS</productname>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    23
	<productnumber>5.11</productnumber>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    24
    </refentryinfo>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    25
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    26
    <refmeta>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    27
	<refentrytitle>rad</refentrytitle>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    28
	<manvolnum>1m</manvolnum>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    29
	<refmiscinfo class="manual">System Administration Commands</refmiscinfo>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    30
    </refmeta>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    31
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    32
    <refnamediv>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    33
	<refname>rad</refname>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    34
	<refpurpose>the Remote Administration Daemon</refpurpose>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    35
    </refnamediv>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    36
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    37
    <refsynopsisdiv>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    38
	<cmdsynopsis>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    39
	    <command>/usr/lib/rad/rad</command>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    40
	    <arg choice="opt"><option>-d</option></arg>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    41
	    <arg choice="opt">
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    42
		<option>-S</option> <replaceable>fmri</replaceable>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    43
	    </arg>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    44
	    <arg choice="opt" rep="repeat">
595
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    45
		<option>-M</option> <replaceable>module</replaceable>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    46
		<!-- DocBook doesn't render repeating arguments well -->
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    47
		<arg choice="opt">
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    48
		    <option>-M</option> <replaceable>module</replaceable>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    49
		</arg>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    50
	    </arg>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
    51
	    <arg choice="opt" rep="repeat">
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    52
		<option>-m</option> <replaceable>moduledir</replaceable>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    53
		<!-- DocBook doesn't render repeating arguments well -->
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    54
		<arg choice="opt">
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    55
		    <option>-m</option> <replaceable>moduledir</replaceable>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    56
		</arg>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    57
	    </arg>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    58
	    <arg choice="opt" rep="repeat">
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    59
		<option>-t</option> <replaceable>transpec</replaceable>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    60
		<!-- DocBook doesn't render repeating arguments well -->
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    61
		<arg choice="opt">
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    62
		    <option>-t</option> <replaceable>transpec</replaceable>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    63
		</arg>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    64
	    </arg>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    65
	</cmdsynopsis>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    66
    </refsynopsisdiv>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    67
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    68
    <refsection><title>Description</title>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    69
	<para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    70
	    rad is a daemon that runs in the background on each Solaris
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    71
	    system.  rad provides secure access to system configuration,
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    72
	    optionally to clients on the network.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    73
	</para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    74
    </refsection>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    75
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    76
    <refsection><title>Options</title>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    77
	<para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    78
	    The following options are available for use on the command
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    79
	    line:
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    80
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    81
	    <variablelist>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    82
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    83
	    <varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    84
	    <term><option>-d</option></term>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    85
	    <listitem><para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    86
		    Emit verbose debugging output.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    87
	    </para></listitem>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    88
	    </varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    89
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    90
	    <varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    91
	    <term><option>-S</option> <replaceable>fmri</replaceable></term>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    92
	    <listitem><para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    93
		Read configuration from the SMF service specified by
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    94
		<replaceable>fmri</replaceable>.  Configured transports are
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    95
		not read from the service to avoid endpoint conflicts with
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    96
		a running service.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    97
	    </para><para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    98
		Module directories specified on the command line are
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    99
		searched before module directories configured in SMF,
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   100
		permitting command line configuration to override SMF
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   101
		configuration.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   102
	    </para></listitem>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   103
	    </varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   104
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   105
	    <varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   106
	    <term>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   107
		<option>-m</option> <replaceable>moduledir</replaceable>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   108
	    </term>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   109
	    <listitem><para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   110
		Add <replaceable>moduledir</replaceable> to the list of
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   111
		directories to scan and load modules from.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   112
	    </para></listitem>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   113
	    </varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   114
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   115
	    <varlistentry>
595
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   116
	    <term>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   117
		<option>-M</option> <replaceable>module</replaceable>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   118
	    </term>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   119
	    <listitem><para>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   120
		Add <replaceable>module</replaceable> to the list of
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   121
		modules to load.  <replaceable>module</replaceable>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   122
		should be an absolute or relative pathname.  Modules
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   123
		loaded with <option>-M</option> take precedence over
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   124
		modules found using <option>-m</option>.
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   125
	    </para></listitem>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   126
	    </varlistentry>
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   127
725a82f60b1c 17332 support loading specific modules
David Powell <david.e.powell@oracle.com>
parents: 587
diff changeset
   128
	    <varlistentry>
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   129
	    <term><option>-t</option> <replaceable>transpec</replaceable></term>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   130
	    <listitem><para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   131
		Instantiate a transport specified by transport
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   132
		specification <replaceable>transpec</replaceable>.  A
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   133
		transport specification has the following format:
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   134
		<!-- On one line to eliminate unwanted whitespace in output -->
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   135
		<replaceable>transport</replaceable>[:<replaceable>option</replaceable>[=<replaceable>value</replaceable>][,<replaceable>option2</replaceable>[=<replaceable>value2</replaceable>]]...]
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   136
	    </para></listitem>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   137
	    </varlistentry>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   138
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   139
	    </variablelist>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   140
	</para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   141
    </refsection>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   142
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   143
    <refsection><title>Notes</title>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   144
	<para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   145
	    A system-provided instance of rad is delivered as
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   146
	    <uri>svc:/system/rad:default</uri>.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   147
	</para>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   148
    </refsection>
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
   149
</refentry>