summaryrefslogtreecommitdiff
path: root/man/mate-power-backlight-helper.sgml
blob: d562a63b76e67ea7584554501f2dfe718eda5f6b (plain)
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
<!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.

  -->

  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY date        "<date>21 April, 2014</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY package     "mate-power-backlight-helper">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      <email>richard@hughsie.com</email>;
    </address>
    <author>
      <firstname>Richard</firstname>
      <surname>Hughes</surname>
    </author>
    <copyright>
      <year>2005</year>
      <holder>Richard Hughes</holder>
    </copyright>
    &date;
  </refentryinfo>
  <refmeta>
    <refentrytitle>mate-power-backlight-helper</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&package;</refname>

    <refpurpose>helper application for MATE's power management backlight control</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&package;</command>
      <arg><option>--help</option></arg>
      <arg><option>--set-brightness</option></arg>
      <arg><option>--get-brightness</option></arg>
      <arg><option>--get-max-brightness</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

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

    <para><command>&package;</command> is a helper utility for controlling the backlight of TFT displays via the MATE power manager userspace daemon.</para>
	<para>The <command>&package;</command> requires to be run with root privileges.</para>

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

    <para>This program follows 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>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--set-brightness BRIGHTNESS_LEVEL</option>
        </term>
        <listitem>
          <para>Set the given brightness.</para>
        </listitem>
      </varlistentry>
  	  <varlistentry>
        <term>
          <option>--get-brightness</option>
        </term>
        <listitem>
          <para>Get the current brightness.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--get-max-brightness</option>
        </term>
        <listitem>
          <para>Get the number of brightness levels supported.</para>
        </listitem>
      </varlistentry>
 
	</variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>mate-power-manager (1).</para>

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

    <para>This manual page has been written by Mike Gabriel <email>mike.gabriel@das-netzwerkteam.de</email> for
      the <productname>Debian</productname> system (but may be used by others).
    </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:
-->