File: bluemon.sgml

package info (click to toggle)
bluemon 1.4-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 284 kB
  • sloc: ansic: 2,567; makefile: 305; sh: 104; xml: 24
file content (240 lines) | stat: -rw-r--r-- 7,772 bytes parent folder | download | duplicates (7)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Matthew</firstname>">
  <!ENTITY dhsurname   "<surname>Johnson</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>November  1, 2005</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>&lt;debian@matthew.ath.cx&gt;</email>">
  <!ENTITY dhusername  "Matthew Johnson">
  <!ENTITY dhucpackage "<refentrytitle>BLUEMON</refentrytitle>">
  <!ENTITY dhpackage   "bluemon">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2005</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Activate or deactivate programs based on bluetooth link quality</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
         <!--arg><option>-c <replaceable>configfile</replaceable></option></arg> 
         <arg><option>- -config <replaceable>configfile</replaceable></option></arg-->
         <arg><option>-b <replaceable>aa:bb:cc:dd:ee:ff</replaceable></option></arg>
         <arg><option>--btid <replaceable>aa:bb:cc:dd:ee:ff</replaceable></option></arg>
         <arg><option>-t <replaceable>threshold</replaceable></option></arg> 
         <arg><option>--threshold <replaceable>threshold</replaceable></option></arg>
         <arg><option>-i <replaceable>interval</replaceable></option></arg> 
         <arg><option>--interval <replaceable>interval</replaceable></option></arg>
         <arg><option>-s </option></arg>
         <arg><option>--stdout </option></arg>
         <arg><option>--no-syslog </option></arg>
         <arg><option>-n </option></arg>
         <arg><option>--no-fork </option></arg>
         <arg><option>-v </option></arg>
         <arg><option>--verbose </option></arg>
         <arg><option>-d </option></arg>
         <arg><option>--disconnect-hack </option></arg>
         <arg><option>-q </option></arg>
         <arg><option>--link-quality </option></arg>
         <arg><option>-h </option></arg>
         <arg><option>--help </option></arg>
         <arg><option>-V </option></arg>
         <arg><option>--version </option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> monitors the quality of the link 
      to a bluetooth device
      and emits dbus signals when it drops below a given threshold
      or disconnects. Used with the bluemon-client program, This can 
      be used to perform actions like locking the terminal when you 
      walk away from it.
    </para>


  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below. 
    </para>

    <variablelist>
      <varlistentry>
        <term><option>-i</option>
          <option>--interval</option>
        </term>
        <listitem>
          <para>The check interval, in ms.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>
          <option>--threshold</option>
        </term>
        <listitem>
          <para>The link quality threshold, out of 255</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-b</option>
          <option>--btid</option>
        </term>
        <listitem>
          <para>The bluetooth ID to monitor (e.g. aa:bb:cc:dd:ee:ff). This parameter may be specified multiple times to monitor multiple devices.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
          <option>--stdout</option>
          <option>--no-syslog</option>
        </term>
        <listitem>
         <para>Log to stdout rather than syslog</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option>
          <option>--no-fork</option>
        </term>
        <listitem>
         <para>Do not become a daemon</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option>
          <option>--disconnect-hack</option>
        </term>
        <listitem>
         <para>Enable this if your bluetooth device disconnects regularly while still in range,
         adds a small delay into noticing device abscence upon disconnect.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--verbose</option>
        </term>
        <listitem>
         <para>Enable verbose output</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-q</option>
          <option>--link-quality</option>
        </term>
        <listitem>
          <para>Check for link quality to device. Default only checks for presence of connection.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-V</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>print version.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>hcitool (1), bluemon-client(1), bluemon-query(1), bluemon-dbus(7).</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->