← Back to branch summary

~ubuntu-branches/ubuntu/utopic/usb-modeswitch/utopic-proposed

« back to all changes in this revision

Viewing changes to debian/usb_modeswitch.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Raboud
  • Date: 2010-01-28 15:17:38 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20100128151738-hwmmaq09dmzyuvgr
Tags: 1.1.0-1
The "All your base are belong to us" release. It was great to collaborate 
with upstream on that release. Thanks Josh!

* New 1.1.0 upstream version.
  - Debian manpage got included, drop docbook-to-man.
  - Merge the two wrappers and put them in /lib/udev/.
* Add a lintian override for the polyglot in /lib/udev/
* Update debian/watch to new upstream tarball naming.
* Bump dependency on -data to 20100127-1.
* Suggest comgt instead of gcom.
* Patches:
  + 01_mf_install_all_path.patch
     Add
       - Ensures that the directories are created before accessing them
       - Disables the udev rules reload
  + 02_mp_correct_hyphens.patch
    Add to correct hyphen-used-as-minus-sign on the manpage.
  - 03_build_system_to_policy.patch
     Merged upstream.
  - 05_move_wrappers_to_usr.patch
     Merged upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/usb_modeswitch.sgml
1
 
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
 
  <!ENTITY dhfirstname "<firstname>Didier</firstname>">
3
 
  <!ENTITY dhsurname   "<surname>Raboud</surname>">
4
 
  <!-- Please adjust the date whenever revising the manpage. -->
5
 
  <!ENTITY dhdate      "<date>January 30, 2009</date>">
6
 
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
7
 
  <!ENTITY dhemail     "<email>didier@raboud.com</email>">
8
 
  <!ENTITY dhusername  "Didier Raboud">
9
 
  <!ENTITY dhucpackage "<refentrytitle>USB-MODESWITCH</refentrytitle>">
10
 
  <!ENTITY dhpackage   "usb-modeswitch">
11
 
 
12
 
  <!ENTITY debian      "<productname>Debian</productname>">
13
 
  <!ENTITY gnu         "<acronym>GNU</acronym>">
14
 
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
15
 
]>
16
 
 
17
 
<refentry>
18
 
  <refentryinfo>
19
 
    <address>
20
 
      &dhemail;
21
 
    </address>
22
 
    <author>
23
 
      &dhfirstname;
24
 
      &dhsurname;
25
 
    </author>
26
 
    <copyright>
27
 
      <year>2009</year>
28
 
      <holder>&dhusername;</holder>
29
 
    </copyright>
30
 
    &dhdate;
31
 
  </refentryinfo>
32
 
  <refmeta>
33
 
    &dhucpackage;
34
 
 
35
 
    &dhsection;
36
 
  </refmeta>
37
 
  <refnamediv>
38
 
    <refname>&dhpackage;</refname>
39
 
 
40
 
    <refpurpose>Switching tool for controlling "flip flop" USB devices</refpurpose>
41
 
  </refnamediv>
42
 
  <refsynopsisdiv>
43
 
    <cmdsynopsis>
44
 
      <command>&dhpackage;</command>
45
 
      <arg><option>-hvpVPmMrdHn</option></arg>
46
 
 
47
 
      <arg><option>-c <replaceable>filename</replaceable></option></arg>
48
 
    </cmdsynopsis>
49
 
  </refsynopsisdiv>
50
 
  <refsect1>
51
 
    <title>DESCRIPTION</title>
52
 
 
53
 
    <para>This manual page was written for the &debian; distribution
54
 
      because the original program does not have a manual page.
55
 
    </para>
56
 
 
57
 
    <para>
58
 
 Several new USB devices have their proprietary Windows drivers onboard,
59
 
 especially WAN dongles. When plugged in for the first time, they act
60
 
 like a flash storage and start installing the driver from there. If
61
 
 the driver is already installed, the storage device vanishes and
62
 
 a new device, such as an USB modem, shows up. This is called the
63
 
 "ZeroCD" feature.
64
 
    </para>
65
 
    <para>
66
 
 On Debian, this is not needed, since the driver is included as a
67
 
 Linux kernel module, such as "usbserial". However, the device still
68
 
 shows up as "usb-storage" by default. <command>&dhpackage;</command> solves that
69
 
 issue by sending the command which actually performs the switching
70
 
 of the device from "usb-storage" to "usbserial".
71
 
    </para>
72
 
 
73
 
  </refsect1>
74
 
  <refsect1>
75
 
    <title>OPTIONS</title>
76
 
 
77
 
    <para>These programs follow the usual &gnu; command line syntax,
78
 
      with long options starting with two dashes (`-').  A summary of
79
 
      options is included below.</para>
80
 
 
81
 
    <variablelist>
82
 
      <varlistentry>
83
 
        <term><option>-h</option>
84
 
          <option>--help</option>
85
 
        </term>
86
 
        <listitem>
87
 
          <para>Show summary of options.</para>
88
 
        </listitem>
89
 
      </varlistentry>
90
 
 
91
 
      <varlistentry>
92
 
        <term><option>-e</option>
93
 
          <option>--version</option>
94
 
        </term>
95
 
        <listitem>
96
 
          <para>Print version number and exit.</para>
97
 
        </listitem>
98
 
      </varlistentry>
99
 
 
100
 
      <varlistentry>
101
 
        <term><option>-v</option>
102
 
          <option>--default-vendor [nr]</option>
103
 
        </term>
104
 
        <listitem>
105
 
          <para>Vendor ID to look for (mandatory).</para>
106
 
        </listitem>
107
 
      </varlistentry>
108
 
 
109
 
      <varlistentry>
110
 
        <term><option>-p</option>
111
 
          <option>--default-product [nr]</option>
112
 
        </term>
113
 
        <listitem>
114
 
          <para>Product ID to look for (mandatory).</para>
115
 
        </listitem>
116
 
      </varlistentry>
117
 
 
118
 
      <varlistentry>
119
 
        <term><option>-V</option>
120
 
          <option>--target-vendor [nr]</option>
121
 
        </term>
122
 
        <listitem>
123
 
          <para>Target Vendor (optional, for success check).</para>
124
 
        </listitem>
125
 
      </varlistentry>
126
 
 
127
 
      <varlistentry>
128
 
        <term><option>-P</option>
129
 
          <option>--target-product [nr]</option>
130
 
        </term>
131
 
        <listitem>
132
 
          <para>Target Model (optional, for success check).</para>
133
 
        </listitem>
134
 
      </varlistentry>
135
 
 
136
 
      <varlistentry>
137
 
        <term><option>-C</option>
138
 
          <option>--target-class [nr]</option>
139
 
        </term>
140
 
        <listitem>
141
 
          <para>Target Device Class</para>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
 
145
 
      <varlistentry>
146
 
        <term><option>-m</option>
147
 
          <option>--message-endpoint [nr]</option>
148
 
        </term>
149
 
        <listitem>
150
 
          <para>Where to direct the message</para>
151
 
        </listitem>
152
 
      </varlistentry>
153
 
 
154
 
      <varlistentry>
155
 
        <term><option>-M</option>
156
 
          <option>--message-content [nr]</option>
157
 
        </term>
158
 
        <listitem>
159
 
          <para>Command to send (hex as string)</para>
160
 
        </listitem>
161
 
      </varlistentry>
162
 
 
163
 
      <varlistentry>
164
 
        <term><option>-r</option>
165
 
          <option>--response-endpoint [nr]</option>
166
 
        </term>
167
 
        <listitem>
168
 
          <para>If given, read response from there</para>
169
 
        </listitem>
170
 
      </varlistentry>
171
 
 
172
 
     <varlistentry>
173
 
        <term><option>-d</option>
174
 
          <option>--detach-only</option>
175
 
        </term>
176
 
        <listitem>
177
 
          <para>Whether to just detach the storage driver</para>
178
 
        </listitem>
179
 
      </varlistentry>
180
 
 
181
 
     <varlistentry>
182
 
        <term><option>-H</option>
183
 
          <option>--huawei-mode</option>
184
 
        </term>
185
 
        <listitem>
186
 
          <para>Whether to just apply the Huawei mode</para>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
 
190
 
     <varlistentry>
191
 
        <term><option>-S</option>
192
 
          <option>--sierra-mode</option>
193
 
        </term>
194
 
        <listitem>
195
 
          <para>Whether to just apply the Sierra mode</para>
196
 
        </listitem>
197
 
      </varlistentry>
198
 
 
199
 
     <varlistentry>
200
 
        <term><option>-O</option>
201
 
          <option>--sony-mode</option>
202
 
        </term>
203
 
        <listitem>
204
 
          <para>Whether to just apply the Sony mode</para>
205
 
        </listitem>
206
 
      </varlistentry>
207
 
 
208
 
     <varlistentry>
209
 
        <term><option>-G</option>
210
 
          <option>--gct-mode</option>
211
 
        </term>
212
 
        <listitem>
213
 
          <para>Whether to just apply the GCT mode</para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
217
 
     <varlistentry>
218
 
        <term><option>-R</option>
219
 
          <option>--resetUSB</option>
220
 
        </term>
221
 
        <listitem>
222
 
          <para>Whether to reset the device in the end</para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
 
226
 
     <varlistentry>
227
 
        <term><option>-c</option>
228
 
          <option>--config [filename]</option>
229
 
        </term>
230
 
        <listitem>
231
 
          <para>Load different config file</para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
     <varlistentry>
236
 
 
237
 
        <term><option>-Q</option>
238
 
          <option>--quiet</option>
239
 
        </term>
240
 
        <listitem>
241
 
          <para>Don't show progress or error messages</para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
 
245
 
     <varlistentry>
246
 
        <term><option>-W</option>
247
 
          <option>--verbose</option>
248
 
        </term>
249
 
        <listitem>
250
 
          <para>Print all settings before running</para>
251
 
        </listitem>
252
 
      </varlistentry>
253
 
 
254
 
     <varlistentry>
255
 
        <term><option>-s</option>
256
 
          <option>--success [nr]</option>
257
 
        </term>
258
 
        <listitem>
259
 
          <para>Check switching result after [nr] secs</para>
260
 
        </listitem>
261
 
      </varlistentry>
262
 
 
263
 
     <varlistentry>
264
 
 
265
 
     <varlistentry>
266
 
        <term><option>-I</option>
267
 
          <option>--no-inquire</option>
268
 
        </term>
269
 
        <listitem>
270
 
          <para>do not get device details (default on)</para>
271
 
        </listitem>
272
 
      </varlistentry>
273
 
 
274
 
        <term><option>-i</option>
275
 
          <option>--interface [nr]</option>
276
 
        </term>
277
 
        <listitem>
278
 
          <para>Select initial USB interface (default: 0)</para>
279
 
        </listitem>
280
 
      </varlistentry>
281
 
 
282
 
     <varlistentry>
283
 
        <term><option>-u</option>
284
 
          <option>--configuration [nr]</option>
285
 
        </term>
286
 
        <listitem>
287
 
          <para>Select USB configuration</para>
288
 
        </listitem>
289
 
      </varlistentry>
290
 
 
291
 
     <varlistentry>
292
 
        <term><option>-a</option>
293
 
          <option>--altsetting [nr]</option>
294
 
        </term>
295
 
        <listitem>
296
 
          <para>Select alternative USB interface setting</para>
297
 
        </listitem>
298
 
      </varlistentry>
299
 
 
300
 
    </variablelist>
301
 
  </refsect1>
302
 
  <!--refsect1>
303
 
    <title>SEE ALSO</title>
304
 
 
305
 
    <para>bar (1), baz (1).</para>
306
 
 
307
 
    <para>The programs are documented fully by <citetitle>The Rise and
308
 
      Fall of a Fooish Bar</citetitle> available via the
309
 
      <application>Info</application> system.</para>
310
 
  </refsect1-->
311
 
  <refsect1>
312
 
    <title>AUTHOR</title>
313
 
 
314
 
    <para>This manual page was written by &dhusername; &dhemail; for
315
 
      the &debian; system (and may be used by others).  Permission is
316
 
      granted to copy, distribute and/or modify this document under
317
 
      the terms of the &gnu; General Public License, Version 2 any
318
 
      later version published by the Free Software Foundation.
319
 
    </para>
320
 
    <para>
321
 
      On Debian systems, the complete text of the GNU General Public
322
 
      License can be found in /usr/share/common-licenses/GPL.
323
 
    </para>
324
 
 
325
 
  </refsect1>
326
 
</refentry>
327
 
 
328
 
<!-- Keep this comment at the end of the file
329
 
Local variables:
330
 
mode: sgml
331
 
sgml-omittag:t
332
 
sgml-shorttag:t
333
 
sgml-minimize-attributes:nil
334
 
sgml-always-quote-attributes:t
335
 
sgml-indent-step:2
336
 
sgml-indent-data:t
337
 
sgml-parent-document:nil
338
 
sgml-default-dtd-file:nil
339
 
sgml-exposed-tags:nil
340
 
sgml-local-catalogs:nil
341
 
sgml-local-ecat-files:nil
342
 
End:
343
 
-->