|
1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [ |
|
2 <!--ArborText, Inc., 1988-1999, v.4002--> |
|
3 <!ENTITY cmd "gnome-volcheck"> |
|
4 <!ENTITY % commonents SYSTEM "smancommon.ent"> |
|
5 %commonents; |
|
6 <!ENTITY % booktitles SYSTEM "booktitles.ent"> |
|
7 %booktitles; |
|
8 <!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved."> |
|
9 ]> |
|
10 <?Pub UDT _bookmark _target> |
|
11 <?Pub Inc> |
|
12 <refentry id="gnome-volcheck-1"> |
|
13 <!-- %Z%%M% %I% %E% SMI; --> |
|
14 <refmeta><refentrytitle>gnome-volcheck</refentrytitle><manvolnum>1</manvolnum> |
|
15 <refmiscinfo class="date">2 Ap<?Pub Caret>r 2003</refmiscinfo> |
|
16 <refmiscinfo class="sectdesc">&man1;</refmiscinfo> |
|
17 <refmiscinfo class="software">&release;</refmiscinfo> |
|
18 <refmiscinfo class="arch">generic</refmiscinfo> |
|
19 <refmiscinfo class="copyright">&suncopy;</refmiscinfo> |
|
20 </refmeta> |
|
21 <indexterm><primary>gnome-volcheck</primary></indexterm><indexterm><primary> |
|
22 monitors the removable media</primary></indexterm><refnamediv id="gnome-volcheck-1-name"> |
|
23 <refname>gnome-volcheck</refname><refpurpose>monitors removable media</refpurpose> |
|
24 </refnamediv> |
|
25 <refsynopsisdiv id="gnome-volcheck-1-synp"><title>&synp-tt;</title> |
|
26 <cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>i <replaceable> |
|
27 time</replaceable></option></arg><arg choice="opt"><option>z <replaceable> |
|
28 time</replaceable></option></arg><arg choice="opt"><option>m <replaceable> |
|
29 media-types</replaceable></option></arg> |
|
30 </cmdsynopsis></refsynopsisdiv> |
|
31 <refsect1 id="gnome-volcheck-1-desc"><title>&desc-tt;</title> |
|
32 <para>The <command>&cmd;</command> daemon monitors removable media for GNOME. <command>&cmd;</command> |
|
33 is launched as a child process of <command>gnome-session</command>.</para> |
|
34 <para><command>&cmd;</command> performs the following functions:<itemizedlist> |
|
35 <listitem><para>Removes any existing notification pipe used by <command>&cmd;</command> |
|
36 to communicate with Action File Manager, as configured by <citerefentry><refentrytitle> |
|
37 rmmount.conf</refentrytitle><manvolnum>4</manvolnum></citerefentry>. </para> |
|
38 </listitem> |
|
39 <listitem><para>Creates a new notification pipe to which Action File Manager |
|
40 writes.</para></listitem> |
|
41 <listitem><para>Listens on the notification pipe and interprets the data received. |
|
42 </para></listitem> |
|
43 <listitem><para>Launches the appropriate applications based on the data sent |
|
44 by Action File Manager.</para></listitem> |
|
45 </itemizedlist></para> |
|
46 </refsect1> |
|
47 <refsect1 id="gnome-volcheck-1-exde"><title>&exde-tt;</title> |
|
48 <para><command>&cmd;</command> listens to the events generated by Action File |
|
49 Manager, but only processes the media insert events. When an insert event |
|
50 occurs, <command>&cmd;</command> may perform a number of actions. These actions |
|
51 are based on the contents of the data files in the <filename>/tmp/.removable |
|
52 </filename> directory, as follows:<itemizedlist> |
|
53 <listitem><para>If a data file contains the text <literal>password_protected |
|
54 </literal>, <command>&cmd;</command> launches the GNOME protect media application |
|
55 to protect the corresponding media.</para></listitem> |
|
56 <listitem><para>If a data file contains the text <literal>unformatted_media |
|
57 </literal>, <command>&cmd;</command> launches the GNOME format media application |
|
58 to format the corresponding media.</para></listitem> |
|
59 <listitem><para>If a data file contains the text <literal>audio_only</literal>, <command>&cmd;</command> |
|
60 launches GNOME CD Player.</para></listitem> |
|
61 <listitem><para>If a data file does not contain any of the above, <command>&cmd;</command> |
|
62 launches Nautilus file manager to handle the corresponding media. For multisegment |
|
63 media, <command>&cmd;</command> launches a single file-manager view, instead |
|
64 of a file-manager view per segment.</para></listitem> |
|
65 </itemizedlist></para> |
|
66 </refsect1> |
|
67 <refsect1 id="gnome-volcheck-1-opts"><title>&opts-tt;</title> |
|
68 <para>The following options are supported:</para> |
|
69 <variablelist termlength="narrow"><varlistentry><term><option>i <replaceable> |
|
70 time</replaceable></option></term><listitem><para>Specifies the number of |
|
71 seconds to wait before starting the file manager. </para> |
|
72 <para>The minimum value is 0 seconds. The maximum value is 65535 seconds. |
|
73 The default value is <literal>30</literal> seconds. If the specified value |
|
74 is close to the minimum or maximum value, the removable media feature may |
|
75 not work. If the specified value is outside the permitted range, the default |
|
76 value is used.</para> |
|
77 <para>If the file manager is in the user's session, the delay will ensure |
|
78 that the file manager desktop view is started instead of the file manager |
|
79 view, if any media is present in the drive during login. If the file manager |
|
80 is not in the user's session, the delay will minimize the impact of run-time |
|
81 load on the system.</para> |
|
82 </listitem></varlistentry> |
|
83 <varlistentry><term><option>z <replaceable>time</replaceable></option></term> |
|
84 <listitem><para>Specifies the number of seconds to wait before checking the |
|
85 notification file. </para> |
|
86 <para>The minimum value is 0 seconds. The maximum value is 65535 seconds. |
|
87 The default value is <literal>3</literal> seconds. If the specified value |
|
88 is close to the minimum or maximum value, the removable media feature may |
|
89 not work. If the specified value is outside the permitted range, the default |
|
90 value is used.</para> |
|
91 <para>This option is needed for multisegment media. Action File Manager creates |
|
92 an insert event per segment. After 3 seconds sleep, <command>&cmd;</command> |
|
93 checks to see whether there are additional insert events. This check is necessary |
|
94 to ensure that <command>&cmd;</command> can handle correctly all events generated |
|
95 by Action File Manager.</para> |
|
96 </listitem></varlistentry> |
|
97 <varlistentry><term><option>m <replaceable>media</replaceable></option></term> |
|
98 <listitem><para>Specifies the media types to be monitored. The supported values |
|
99 are <literal>cdrom</literal>, <literal>floppy</literal>, <literal>zip</literal>, <literal> |
|
100 jaz</literal>, and <literal>dvdrom</literal>. If the <option>m</option> option |
|
101 is not specified, all media types are monitored.</para> |
|
102 </listitem></varlistentry> |
|
103 </variablelist></refsect1> |
|
104 <refsect1 id="gnome-volcheck-1-exam"><title>&exam-tt;</title> |
|
105 <example role="example"><title>Monitoring Several Removable Media With &cmd;</title> |
|
106 <para><screen>example% <userinput>&cmd; -i 40 -z 4 -m cdrom,zip,jaz,dvdrom |
|
107 </userinput></screen></para> |
|
108 </example> |
|
109 <para>This example shows how to run <command>&cmd;</command> with an initial |
|
110 sleep time of 40 seconds, and with 4 seconds of wait time before reading data |
|
111 files, to monitor the CD-ROM, Zip, Jaz, and DVD—ROM media types.</para> |
|
112 </refsect1> |
|
113 <refsect1 id="gnome-volcheck-1-envr"><title>&envr-tt;</title> |
|
114 <para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum> |
|
115 5</manvolnum></citerefentry> for descriptions of the following environment |
|
116 variables that affect the execution of <command>&cmd;</command>: NLSPATH. |
|
117 </para> |
|
118 </refsect1> |
|
119 <refsect1 id="gnome-volcheck-1-exit"><title>&exit-tt;</title> |
|
120 <para>The following exit values are returned:</para> |
|
121 <variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term> |
|
122 <listitem><para>Application exited successfully</para> |
|
123 </listitem></varlistentry> |
|
124 <varlistentry><term><returnvalue>2</returnvalue></term><listitem><para>Application |
|
125 failed to read from or write to <filename>/tmp/.removable</filename></para> |
|
126 </listitem></varlistentry> |
|
127 <varlistentry><term><returnvalue>3</returnvalue></term><listitem><para>Application |
|
128 failed to create notification pipe</para> |
|
129 </listitem></varlistentry> |
|
130 </variablelist></refsect1> |
|
131 <refsect1 id="gnome-volcheck-1-file"><title>&file-tt;</title> |
|
132 <para>The following files are used by this application:</para> |
|
133 <variablelist termlength="wholeline"><varlistentry><term><filename>/usr/bin/&cmd;</filename> |
|
134 </term><listitem><para>The command-line executable for the application.</para> |
|
135 </listitem></varlistentry> |
|
136 <varlistentry><term><filename>/usr/dt/config/Xinitrc.Sun-gnome-2.0-fcs</filename> |
|
137 </term><listitem><para>The Sun GNOME Xsession startup configuration script. |
|
138 </para> |
|
139 </listitem></varlistentry> |
|
140 <varlistentry><term><filename>/tmp/.removable/notify<replaceable>pid</replaceable></filename> |
|
141 </term><listitem><para>The notification pipe.</para> |
|
142 </listitem></varlistentry> |
|
143 </variablelist></refsect1> |
|
144 <refsect1 id="gnome-volcheck-1-attr"><title>&attr-tt;</title> |
|
145 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry> |
|
146 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink> |
|
147 for descriptions of the following attributes:</para> |
|
148 <informaltable frame="all"> |
|
149 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*"> |
|
150 <colspec colname="COLSPEC1" colwidth="1*"> |
|
151 <thead> |
|
152 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center" |
|
153 valign="middle">ATTRIBUTE VALUE</entry></row> |
|
154 </thead> |
|
155 <tbody> |
|
156 <row><entry><para>Availability</para></entry><entry><para>SUNWgnome-removable-media |
|
157 </para></entry></row> |
|
158 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry |
|
159 colname="COLSPEC1"><para>Volatile</para></entry></row> |
|
160 </tbody> |
|
161 </tgroup> |
|
162 </informaltable> |
|
163 </refsect1> |
|
164 <refsect1 id="gnome-volcheck-1-also"><title>&also-tt;</title> |
|
165 <!--Reference to another man page--> |
|
166 <!--Reference to a Help manual--> |
|
167 <!--Reference to a book.--> |
|
168 <para><citerefentry><refentrytitle>nautilus</refentrytitle><manvolnum>1</manvolnum> |
|
169 </citerefentry>, <citerefentry><refentrytitle>vold</refentrytitle><manvolnum> |
|
170 1M</manvolnum></citerefentry>, <citerefentry><refentrytitle>rmmount</refentrytitle> |
|
171 <manvolnum>1M</manvolnum></citerefentry>, <citerefentry><refentrytitle>rmmount.conf |
|
172 </refentrytitle><manvolnum>4</manvolnum></citerefentry></para> |
|
173 </refsect1> |
|
174 <refsect1 id="gnome-volcheck-1-note"><title>¬e-tt;</title> |
|
175 <para><command>&cmd;</command> is a system administration program. It must |
|
176 be invoked as a child of <command>gnome-session</command>. If invoked in any |
|
177 other way, <command>&cmd;</command> behavior is not predictable.</para> |
|
178 <para>Written by Ghee Teo, Sun Microsystems Inc., 2003.</para> |
|
179 </refsect1> |
|
180 </refentry> |
|
181 <?Pub *0000010079> |