1 XNEdit Version 1.6, December 2024
2 =================================
3
4 XNEdit is a multi-purpose text editor for the X Window System, which combines
5 a standard, easy to use, graphical user interface with the thorough
6 functionality and stability required by users who edit text eight hours a day.
7 It provides intensive support for development in a wide variety of languages,
8 text processors, and other tools, but at the same time can be used productively
9 by just about anyone who needs to edit text.
10
11 XNEdit is a fork of the Nirvana Editor (NEdit) and provides new functionality
12 like antialiased text rendering and support for unicode.
13
14 BUILDING XNEDIT
15 ---------------
16
17 Pre-built executables will be available for many operating system. Check out
18 the [XNEdit web page](https://www.unixwork.de/xnedit/).
19
20 If you have downloaded a pre-built executable you can skip ahead to the section
21 called INSTALLATION. Otherwise, the requirements to build XNEdit from the
22 sources are:
23
24 - ANSI C99 compiler
25 - make utility (eg, GNU make)
26 - pkg-config
27 - X11 development stuff (headers, libraries)
28 - Xrender and Xft
29 - iconv (*BSD, cygwin)
30 - Fontconfig
31 - Motif 2.0 or above
32
33 Optionally one may use:
34
35 - yacc (or GNU bison)
36
37 You can install all necessary dependencies with the following command.
38
39 Debian/Ubuntu:
40
41 apt install gcc make pkgconf libmotif-dev
42
43 EL/Fedora:
44
45 dnf install gcc make pkgconf motif-devel
46
47 openSUSE:
48
49 zypper install gcc make pkg-config motif-devel
50
51 Arch:
52
53 pacman -S gcc make pkgconf openmotif
54
55 FreeBSD:
56
57 pkg install pkgconf open-motif libiconv
58
59 Solaris/OpenIndiana:
60
61 pkg install gcc make pkgconf motif
62
63 Cygwin:
64
65 setup-x86_64.exe -qP gcc-g++,make,git,pkg-config,libX11-devel,libXt-devel,libXm-devel,libXrender-devel,libXft-devel,libiconv-devel,libfontconfig-devel,motif,bison
66
67 To build XNEdit from source, run make from XNEdit's root directory and specify
68 the build-configuration:
69
70 make <build-config>
71
72 Available configurations are:
73
74 - linux
75 - solaris
76 - freebsd
77 - netbsd
78 - openbsd
79 - macos
80 - cygwin
81 - generic
82
83 If everything works properly, this will produce two executables called
84 'xnedit' and 'xnc' in the directory called 'source'.
85
86 INSTALLATION
87 ------------
88
89 To install the XNEdit binaries and desktop integration files, run as root:
90
91 make install
92
93 This will install the binaries to /usr/bin and desktop integration files to
94 `/usr/share`. The desktop integration consists of a starter file `xnedit.desktop`
95 and the icon `xnedit.png`.
96
97 To install to another destination, specify a path prefix with
98
99 make install PREFIX=/path
100
101 To install just the binaries, copy the files `xnedit` and `xnc` from the
102 `source` directory to your path.
103
104 RUNNING XNEDIT
105 --------------
106
107 To run XNEdit, simply type `xnedit`, optionally followed by the name of a file
108 or files to edit. On-line help is available from the pulldown menu on the far
109 right of the menu bar. For more information on the syntax of the xnedit command
110 line, look under the heading of "XNEdit Command Line".
111
112 The recommended way to use XNEdit, though, is in client/server mode, invoked by
113 the xnc executable. It allows you to edit multiple files within the same
114 instance of XNEdit (but still in multiple windows). This saves memory (only one
115 process keeps running), and enables additional functionality (such as find &
116 replace across multiple windows). See "Server Mode and xnc" in the help menu
117 for more information.
118
119 COMPATIBILITY WITH PREVIOUS VERSIONS
120 ------------------------------------
121
122 ### Upgrading from NEdit 5.7 to XNEdit
123
124 XNEdit uses the same preferences format as NEdit 5.7. Also the X-Resources have
125 the same appname `nedit`. Therefore NEdit's settings are compatible with
126 XNEdit, except the font configuration.
127
128 XNEdit's default configuration directory is `~/.xnedit`. To use your
129 existing NEdit settings in XNEdit, copy the content from `~/.nedit/` to
130 `~/.xnedit` or just rename the `~/.nedit` directory.
131
132 After that, you need to adjust the font settings. To use the default XNEdit
133 font settings, delete the following lines from the nedit.rc file:
134
135 nedit.textFont: ...
136 nedit.boldHighlightFont: ...
137 nedit.italicHighlightFont: ...
138 nedit.boldItalicHighlightFont: ...
139
140 Or alternatively, adjust the fonts directly in XNEdit.
141
142 DOCUMENTATION
143 -------------
144
145 More information is available from XNEdit's on-line help system, the man-pages
146 and from the [web page](https://www.unixwork.de/xnedit/) for XNEdit.
147
148 SUPPORT
149 -------
150
151 Bug reports and feature requests can be issued at github or sourceforge,
152 or contact me via email.
153
154 - https://github.com/unixwork/xnedit/issues
155 - https://sourceforge.net/projects/xnedit/
156 - Olaf Wintermann <olaf.wintermann@gmail.com>
157
158 AUTHORS
159 -------
160
161 XNEdit is based on NEdit 5.7 and developed by Olaf Wintermann.
162
163 NEdit developers: Tony Balinski, Arne Førlie, Nathaniel Gray, Eddy De Greef,
164 Thorsten Haude, Andrew Hood, Scott Tringali, TK Soh, Mark Edel,
165 Joy Kyriakopulos, Christopher Conrad, Jim Clark, Arnulfo Zepeda-Navratil,
166 Suresh Ravoor, Max Vohlken, Yunliang Yu, Donna Reid, Steve Haehn,
167 Steve LoBasso and Alexander Mai.
168
169 Additional NEdit patches by: Fredrik Jönsson, Per Grahn.
170
171 XNEdit contributions: Laszlo Ersek, Mike Becker, Peter Mühlenpfordt and
172 Valerio Messina.
173
174 The regular expression matching routines used in NEdit are adapted (with
175 permission) from original code written by Henry Spencer at the University of
176 Toronto.
177
178 The Microline widgets are inherited from the Mozilla project.
179
180 Syntax highlighting patterns and smart indent macros were contributed by
181 Simon T. MacDonald, Maurice Leysens, Matt Majka, Alfred Smeenk, Alain Fargues,
182 Christopher Conrad, Scott Markinson, Konrad Bernloehr, Ivan Herman,
183 Patrice Venant, Christian Denat, Philippe Couton, Max Vohlken,
184 Markus Schwarzenberg, Himanshu Gohel, Steven C. Kapp, Michael Turomsha,
185 John Fieber, Chris Ross, Nathaniel Gray, Joachim Lous, Mike Duigou,
186 Seak Teng-Fong, Joor Loohuis, Mark Jones and Niek van den Berg.
187
188 LICENSE
189 -------
190
191 XNEdit may be freely distributed under the terms of the GNU
192 General Public License
193
194 See the LICENSE file for more informations.
195
196