README 3.9 KB
Newer Older
Paolo Maggi's avatar
Paolo Maggi committed
1 2
General Information
===================
Jose Maria Celorio's avatar
Jose Maria Celorio committed
3

Ignacio Casal Quinteiro's avatar
Ignacio Casal Quinteiro committed
4
This is version 3.3.2 of gedit. gedit is a small and lightweight UTF-8 text
Paolo Maggi's avatar
Paolo Maggi committed
5
editor for the GNOME environment.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
6

Paolo Borelli's avatar
Paolo Borelli committed
7
gedit is part of GNOME and uses the latest GTK+ and GNOME libraries.
Paolo Maggi's avatar
Paolo Maggi committed
8
Complete GNOME integration is featured, with support for Drag and Drop (DnD) 
Paolo Borelli's avatar
Paolo Borelli committed
9
from Nautilus (the GNOME file manager), the use of the GNOME help system,
Paolo Maggi's avatar
Paolo Maggi committed
10 11
the GNOME Virtual File System and the GNOME print framework.

Paolo Maggi's avatar
Paolo Maggi committed
12 13
gedit uses a Multiple Document Interface (MDI), which lets you edit more than 
one document at the same time.
Paolo Maggi's avatar
Paolo Maggi committed
14 15 16 17

gedit supports most standard editing features, plus several not found in your 
average text editor (plugins being the most notable of these).

Paolo Borelli's avatar
Paolo Borelli committed
18 19 20
gedit plugins may also be written in the python scripting language: to enable
python support you need the pygtk and gnome-python-desktop bindings.

Paolo Borelli's avatar
Paolo Borelli committed
21
Although new features are always under development, currently gedit has:
Paolo Maggi's avatar
Paolo Maggi committed
22 23

    * Complete support for UTF-8 text
Paolo Borelli's avatar
Paolo Borelli committed
24
    * Syntax highlighting
Paolo Borelli's avatar
Paolo Borelli committed
25
    * Support for editing remote files
Paolo Maggi's avatar
Paolo Maggi committed
26
    * Search and Replace
Paolo Borelli's avatar
Paolo Borelli committed
27
    * Printing and Print Previewing Support
Paolo Borelli's avatar
Paolo Borelli committed
28
    * File Revert
Paolo Maggi's avatar
Paolo Maggi committed
29
    * A complete preferences interface
Paolo Borelli's avatar
Paolo Borelli committed
30
    * Configurable Plugin system, with optional python support
Paolo Borelli's avatar
Paolo Borelli committed
31

Paolo Maggi's avatar
Paolo Maggi committed
32 33 34 35

Some of the plugins, packaged and installed with gedit include, among others:

    * Word count
Paolo Borelli's avatar
Paolo Borelli committed
36 37
    * Spell checker
    * Change case of selected text
Paolo Borelli's avatar
Paolo Borelli committed
38
    * File Browser
Paolo Borelli's avatar
Paolo Borelli committed
39
    * Automatic snippet expansion
Paolo Borelli's avatar
Paolo Borelli committed
40
    * Sort
Paolo Maggi's avatar
Paolo Maggi committed
41
    * Insert Date/Time
Paolo Borelli's avatar
Paolo Borelli committed
42 43
    * External Tools
    * Tag list
Paolo Maggi's avatar
Paolo Maggi committed
44

Paolo Borelli's avatar
Paolo Borelli committed
45 46 47
Other external plugins are also available.


Paolo Maggi's avatar
Paolo Maggi committed
48 49 50 51 52 53
gedit is released under the GNU General Public License (GPL) version 2, see
the file 'COPYING' for more information.


The official web site is:

54
    http://www.gedit.org
Paolo Maggi's avatar
Paolo Maggi committed
55

56
You can download the latest gedit tarball from:
Paolo Maggi's avatar
Paolo Maggi committed
57

58
    http://download.gnome.org/sources/gedit/
Paolo Maggi's avatar
Paolo Maggi committed
59 60 61

Information about gedit mailing lists can be found at

Paolo Borelli's avatar
Paolo Borelli committed
62
    http://mail.gnome.org/mailman/listinfo/gedit-list
Paolo Maggi's avatar
Paolo Maggi committed
63 64 65 66 67


Installation
============

Ignacio Casal Quinteiro's avatar
Ignacio Casal Quinteiro committed
68 69
gedit requires GTK+-3.2.x and GtkSourceView 3.0.x and libpeas 1.2.x libraries.
PyGobject 3.0.x and gobject-introspection 0.9.0 are required to enable python
Ignacio Casal Quinteiro's avatar
Ignacio Casal Quinteiro committed
70
plugins support.
Paolo Maggi's avatar
Paolo Maggi committed
71 72 73

Simple install procedure:

Ignacio Casal Quinteiro's avatar
Ignacio Casal Quinteiro committed
74 75
  % tar Jxf gedit-3.3.2.tar.xz			# unpack the sources
  % cd gedit-3.3.2				# change to the toplevel directory
Paolo Borelli's avatar
Paolo Borelli committed
76 77
  % ./configure					# run the `configure' script
  % make					# build gedit
Paolo Maggi's avatar
Paolo Maggi committed
78
  [ Become root if necessary ]
Paolo Borelli's avatar
Paolo Borelli committed
79
  % make install				# install gedit
Paolo Maggi's avatar
Paolo Maggi committed
80 81 82 83 84 85 86 87

See the file 'INSTALL' for more detailed information.


How to report bugs
==================

Bugs should be reported to the GNOME bug tracking system.
Paolo Borelli's avatar
Paolo Borelli committed
88
(http://bugzilla.gnome.org, product gedit). You will need to create an
Paolo Maggi's avatar
Paolo Maggi committed
89 90 91
account for yourself.

You can also report bugs using the GNOME program bug-buddy.
92

Paolo Maggi's avatar
Paolo Maggi committed
93
In the bug report please include:
94

Paolo Maggi's avatar
Paolo Maggi committed
95 96 97 98 99 100 101 102 103 104 105 106
* Information about your system. For instance:

   - What operating system and version
   - What version of X
   - What version of the gtk+, glib and gnome libraries
   - For Linux, what version of the C library

  And anything else you think is relevant.

* How to reproduce the bug. 

* If the bug was a crash, the exact text that was printed out when the
107
  crash occurred.
Paolo Maggi's avatar
Paolo Maggi committed
108 109 110

* Further information such as stack traces may be useful, but is not
  necessary. If you do send a stack trace, and the error is an X error,
Paolo Maggi's avatar
Paolo Maggi committed
111
  it will be more useful if the stack trace is produced running the test
Paolo Maggi's avatar
Paolo Maggi committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
  program with the --sync command line option.

See the file 'BUGS' for the list of known bugs.


Patches
=======

Patches should also be submitted to bugzilla.gnome.org. If the patch
fixes an existing bug, add the patch as an attachment to that bug
report.

Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.

Patches should be in unified diff form. (The -u option to GNU diff.)

If you are interested in helping us to develop gedit, please see the 
file 'AUTHOR' for contact information and/or send a message to the gedit
131
mailing list. See also the file 'HACKING' for more detailed information.
Paolo Maggi's avatar
Paolo Maggi committed
132 133


Paolo Borelli's avatar
Paolo Borelli committed
134
  The gedit team.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
135