components/visual-panels/core/src/doc/manpage/vp.1.xml
changeset 827 0944d8c0158b
equal deleted inserted replaced
826:c6aad84d2493 827:0944d8c0158b
       
     1 <?xml version="1.0" encoding="UTF-8"?>
       
     2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
       
     3 <!--
       
     4   PDL HEADER START
       
     5 
       
     6   Public Documentation License Notice
       
     7 
       
     8   The contents of this Documentation are subject to the Public
       
     9   Documentation License Version 1.01 (the "License"); you may only
       
    10   use this Documentation if you comply with the terms of this License.
       
    11   A copy of the License is available at
       
    12   http://www.opensolaris.org/os/community/documentation/license.
       
    13 
       
    14   PDL HEADER END
       
    15 
       
    16   Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.
       
    17 -->
       
    18 
       
    19 <refentry id="man.vp">
       
    20   <refentryinfo>
       
    21     <productname>SunOS</productname>
       
    22     <productnumber>5.11</productnumber>
       
    23   </refentryinfo>
       
    24 
       
    25   <refmeta>
       
    26     <refentrytitle>vp</refentrytitle>
       
    27     <manvolnum>1</manvolnum>
       
    28     <refmiscinfo class="manual">User Commands</refmiscinfo>
       
    29   </refmeta>
       
    30 
       
    31   <refnamediv>
       
    32     <refname>vp</refname>
       
    33     <refpurpose>starts a Visual Panels UI</refpurpose>
       
    34   </refnamediv>
       
    35 
       
    36   <refsynopsisdiv>
       
    37     <cmdsynopsis>
       
    38       <command>/usr/bin/vp</command>
       
    39       <arg choice="opt">
       
    40         <option>-h</option> <replaceable>host</replaceable>
       
    41       </arg>
       
    42       <arg choice="opt">
       
    43         <option>-p</option> <replaceable>port</replaceable>
       
    44       </arg>
       
    45       <arg choice="opt">
       
    46         <option>-u</option> <replaceable>user</replaceable>
       
    47       </arg>
       
    48       <arg choice="opt">
       
    49         <option>-r</option> <replaceable>role</replaceable>
       
    50       </arg>
       
    51       <arg choice="opt"><option>-j</option></arg>
       
    52       <arg choice="plain" rep="repeat">
       
    53         <replaceable>address</replaceable>
       
    54       </arg>
       
    55     </cmdsynopsis>
       
    56 
       
    57     <cmdsynopsis>
       
    58       <command>/usr/bin/vp</command>
       
    59       <arg choice="plain"><option>-v</option></arg>
       
    60     </cmdsynopsis>
       
    61 
       
    62     <cmdsynopsis>
       
    63       <command>/usr/bin/vp</command>
       
    64       <arg choice="plain"><option>-?</option></arg>
       
    65     </cmdsynopsis>
       
    66   </refsynopsisdiv>
       
    67 
       
    68   <refsection><title>Description</title>
       
    69   <para>
       
    70     <command>vp</command> starts the Visual Panels UI specified by
       
    71     <replaceable>address</replaceable>.
       
    72   </para>
       
    73   </refsection>
       
    74 
       
    75   <refsection><title>Options</title>
       
    76   <para>
       
    77     The following options are supported:
       
    78     <variablelist>
       
    79     <varlistentry>
       
    80     <term><option>-h</option> <replaceable>host</replaceable></term>
       
    81     <listitem><para>
       
    82       Connect to host <replaceable>host</replaceable>.
       
    83     </para></listitem>
       
    84     </varlistentry>
       
    85 
       
    86     <varlistentry>
       
    87     <term><option>-p</option> <replaceable>port</replaceable></term>
       
    88     <listitem><para>
       
    89       Connect to port <replaceable>port</replaceable>.
       
    90     </para></listitem>
       
    91     </varlistentry>
       
    92 
       
    93     <varlistentry>
       
    94     <term><option>-u</option> <replaceable>user</replaceable></term>
       
    95     <listitem><para>
       
    96       Log in as user <replaceable>user</replaceable>.
       
    97     </para></listitem>
       
    98     </varlistentry>
       
    99 
       
   100     <varlistentry>
       
   101     <term><option>-r</option> <replaceable>role</replaceable></term>
       
   102     <listitem><para>
       
   103       Log in as role <replaceable>role</replaceable>.
       
   104     </para></listitem>
       
   105     </varlistentry>
       
   106 
       
   107     <varlistentry>
       
   108     <term><option>-j</option></term>
       
   109     <listitem><para>
       
   110       Launch the specified panel using a new JVM.  Normally an
       
   111       existing JVM is used, if available.
       
   112     </para></listitem>
       
   113     </varlistentry>
       
   114 
       
   115     <varlistentry>
       
   116     <term><option>-v</option></term>
       
   117     <listitem><para>
       
   118       Print the version number and exit.
       
   119     </para></listitem>
       
   120     </varlistentry>
       
   121 
       
   122     <varlistentry>
       
   123     <term><option>-?</option></term>
       
   124     <listitem><para>
       
   125       Print the help message and exit.
       
   126     </para></listitem>
       
   127     </varlistentry>
       
   128     </variablelist>
       
   129   </para>
       
   130   </refsection>
       
   131 
       
   132   <refsection><title>Operands</title>
       
   133   <para>
       
   134     The following operand is supported:
       
   135     <variablelist>
       
   136     <varlistentry>
       
   137     <term><replaceable>address</replaceable></term>
       
   138     <listitem><para>
       
   139       The address of the management panel to open.
       
   140     </para></listitem>
       
   141     </varlistentry>
       
   142     </variablelist>
       
   143   </para>
       
   144   </refsection>
       
   145 
       
   146   <refsection><title>See Also</title>
       
   147   <para>
       
   148     <citerefentry>
       
   149     <refentrytitle>rad</refentrytitle>
       
   150     <manvolnum>1M</manvolnum>
       
   151     </citerefentry>
       
   152   </para>
       
   153   </refsection>
       
   154 </refentry>