Mercurial > projects > xwrited
annotate README @ 23:98b5d974cea5 default tip
Added tag version-3 for changeset 9d00c0e07c47
author | Guido Berhoerster <guido+xwrited@berhoerster.name> |
---|---|
date | Sat, 30 Jun 2018 23:09:12 +0200 |
parents | f0accfc74f7b |
children |
rev | line source |
---|---|
4
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
1 xwrited |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
2 ======= |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
3 |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
4 The xwrited utility displays write(1) and wall(1) messages as desktop |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
5 notifications. A notification daemon compliant to the freedesktop.org Desktop |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
6 Notification Specification draft needs to be running in order to display the |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
7 notifications. |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
8 |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
9 Build Instructions |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
10 ------------------ |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
11 |
10
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
12 xwrited requires a POSIX:2004 compatible operating system, it has been tested |
18
4a5330979433
Modernize and improve build system
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
10
diff
changeset
|
13 to work on Linux distributions, FreeBSD, DragonFly BSD, NetBSD, and Solaris and |
10
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
14 Illumos-derived distributions. The following tools and shared libraries are |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
15 required to build xwrited: |
4
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
16 |
19
f0accfc74f7b
Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
18
diff
changeset
|
17 - GNU make version 3.81 or later |
10
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
18 - GNU or BSD install |
19
f0accfc74f7b
Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
18
diff
changeset
|
19 - GNU gettext 0.19 or later |
f0accfc74f7b
Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
18
diff
changeset
|
20 - GLib version 2.48 or later |
18
4a5330979433
Modernize and improve build system
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
10
diff
changeset
|
21 - libutempter on Linux |
19
f0accfc74f7b
Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
18
diff
changeset
|
22 - the xsltproc tool from libxml2 |
10
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
23 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
24 Before building xwrited check the commented macros in the Makefile for any |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
25 macros you may need to override depending on the used toolchain and operating |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
26 system. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
27 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
28 By default, all files will be installed under the "/usr/local" directory, a |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
29 different installation path prefix can be set via the `prefix` macro. In |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
30 addition, a second path prefix can be specified via the `DESTDIR` macro which |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
31 will be prepended to any path, incuding the `prefix` macro path prefix. In |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
32 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
33 prepended to paths during installation and not be used for constructing |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
34 internal paths. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
35 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
36 The following instructions assume that `make` is GNU make, on some platforms |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
37 it may be installed under a different name or a non-default path. In order to |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
38 start the build process run `make all`. After a successful build, run `make |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
39 install` to install the program, any associated data files and the |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
40 documentation. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
41 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
42 Previously built binaries, object files, generated data files and |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
43 documentation can be removed by running `make clean`, any additional, |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
44 generated files which are not removed by the `clean` target can be removed by |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
45 running `make clobber`. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
46 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
47 Contact |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
48 ------- |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
49 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
50 Please send any feedback, translations or bug reports via email to |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
51 <guido+xwrited@berhoerster.name>. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
52 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
53 Bug Reports |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
54 ----------- |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
55 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
56 When sending bug reports, please always mention the exact version of xwrited |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
57 with which the issue occurs as well as the version of the operating system you |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
58 are using and make sure that you provide sufficient information to reproduce |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
59 the issue and include any input, output, any error messages. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
60 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
61 In case of build issues, please also specify the implementations and versions |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
62 of the tools and shared libraries used to build the program, in particular the |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
63 compiler. |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
64 |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
65 In case of crashes, please generate a stack trace with a suitable debugger |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
66 such as gdb, lldb, dbx, or debug after a crash has occurred either by |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
67 examining the resulting core file or by running the program from the debugger |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
68 and attach it to the bug report. In order to generate a meaningful stack |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
69 trace the program as well as any dynamically linked libraries need to be built |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
70 with debugging information, see the documentation of the used compiler for the |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
71 required compiler flags. If any of the dynamically linked shared libraries do |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
72 not contain debugging information, please either install debugging information |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
73 for these libraries using mechanisms provided by your operating system or |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
74 rebuild the libraries accordingly. Please refer to the documentation of the |
1ec432967d62
Improve README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
4
diff
changeset
|
75 debugger for detailed instructions on generating backtraces. |
4
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
76 |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
77 License |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
78 ------- |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
79 |
19
f0accfc74f7b
Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
18
diff
changeset
|
80 Except otherwise noted, all files are Copyright (C) 2018 Guido Berhoerster and |
4
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
81 distributed under the following license terms: |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
82 |
19
f0accfc74f7b
Port to GLib version 2.48 or later
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
18
diff
changeset
|
83 Copyright (C) 2018 Guido Berhoerster <guido+xwrited@berhoerster.name> |
4
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
84 |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
85 Permission is hereby granted, free of charge, to any person obtaining |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
86 a copy of this software and associated documentation files (the |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
87 "Software"), to deal in the Software without restriction, including |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
88 without limitation the rights to use, copy, modify, merge, publish, |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
89 distribute, sublicense, and/or sell copies of the Software, and to |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
90 permit persons to whom the Software is furnished to do so, subject to |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
91 the following conditions: |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
92 |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
93 The above copyright notice and this permission notice shall be included |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
94 in all copies or substantial portions of the Software. |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
95 |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
96 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
97 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
98 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
99 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
100 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
101 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
f219f96f07c2
Add README file
Guido Berhoerster <guido+xwrited@berhoerster.name>
parents:
diff
changeset
|
102 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |