Mercurial > projects > xinhibit-applet

annotate README @ 17:cb21006b64c7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typo in macro definition
author Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
date Fri, 27 Feb 2015 23:28:06 +0100
parents 82ac993fa76d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
1 XInhibit Applet
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
2 ===============
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
3
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
4 Description
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
5 -----------
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
6
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
7 XInhibit Applet is a system tray applet that allows users to inhibit automatic
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
8 power management.
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
9
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
10 Build Instructions
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
11 ------------------
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
12
16
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
13 xinhibit-applet requires a POSIX:2004 compatible operating system with an X11
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
14 implementation which provides the XTEST extension at runtime, it has been
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
15 tested to work on Linux distributions, FreeBSD, and Solaris and
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
16 Illumos-derived distributions. The following tools and shared libraries are
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
17 required to build xinhibit-applet:
6
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
18
16
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
19 - GNU make >= 3.81
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
20 - GNU or BSD install
6
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
21 - GLib version 2.12 or later
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
22 - GTK+ version 2.18 or later
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
23 - libunique
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
24 - Xlib and the XTEST extension library
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
25
16
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
26 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
27
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
28 Before building xinhibit-applet check the commented macros in the Makefile for
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
29 any macros you may need to override depending on the used toolchain and
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
30 operating system.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
31
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
32 By default, all files will be installed under the "/usr/local" directory, a
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
33 different installation path prefix can be set via the `prefix` macro. In
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
34 addition, a second path prefix can be specified via the `DESTDIR` macro which
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
35 will be prepended to any path, incuding the `prefix` macro path prefix. In
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
36 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
37 prepended to paths during installation and not be used for constructing
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
38 internal paths.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
39
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
40 The following instructions assume that `make` is GNU make, on some platforms
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
41 it may be installed under a different name or a non-default path. In order to
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
42 start the build process run `make all`. After a successful build, run `make
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
43 install` to install the program, any associated data files and the
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
44 documentation.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
45
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
46 Previously built binaries, object files, generated data files and
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
47 documentation can be removed by running `make clean`, any additional,
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
48 generated files which are not removed by the `clean` target can be removed by
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
49 running `make clobber`.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
50
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
51 Contact
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
52 -------
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
53
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
54 Please send any feedback, translations or bug reports via email to
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
55 <guido+xinhibit-applet@berhoerster.name>.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
56
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
57 Bug Reports
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
58 -----------
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
59
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
60 When sending bug reports, please always mention the exact version of
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
61 xinhibit-applet with which the issue occurs as well as the version of the
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
62 operating system you are using and make sure that you provide sufficient
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
63 information to reproduce the issue and include any input, output, any error
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
64 messages.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
65
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
66 In case of build issues, please also specify the implementations and versions
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
67 of the tools and shared libraries used to build the program, in particular the
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
68 compiler.
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
69
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
70 In case of crashes, please generate a stack trace with a suitable debugger
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
71 such as gdb, lldb, dbx, or debug after a crash has occurred either by
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
72 examining the resulting core file or by running the program from the debugger
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
73 and attach it to the bug report. In order to generate a meaningful stack
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
74 trace the program as well as any dynamically linked libraries need to be built
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
75 with debugging information, see the documentation of the used compiler for the
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
76 required compiler flags. If any of the dynamically linked shared libraries do
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
77 not contain debugging information, please either install debugging information
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
78 for these libraries using mechanisms provided by your operating system or
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
79 rebuild the libraries accordingly. Please refer to the documentation of the
82ac993fa76d Improve README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 6
diff changeset
80 debugger for detailed instructions on generating backtraces.
6
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
81
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
82 License
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
83 -------
88623e3fd59e Add some more information to the README file
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents: 0
diff changeset
84
0
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
85 Except otherwise noted, all files are Copyright (C) 2013 Guido Berhoerster and
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
86 distributed under the following license terms:
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
87
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
88 Copyright (C) 2013 Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
89
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
90 Permission is hereby granted, free of charge, to any person obtaining
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
91 a copy of this software and associated documentation files (the
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
92 "Software"), to deal in the Software without restriction, including
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
93 without limitation the rights to use, copy, modify, merge, publish,
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
94 distribute, sublicense, and/or sell copies of the Software, and to
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
95 permit persons to whom the Software is furnished to do so, subject to
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
96 the following conditions:
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
97
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
98 The above copyright notice and this permission notice shall be included
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
99 in all copies or substantial portions of the Software.
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
100
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
101 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
102 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
103 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
104 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
105 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
106 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
9a16bf50daba Initial revision
Guido Berhoerster <guido+xinhibit-applet@berhoerster.name>
parents:
diff changeset
107 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.