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

Paolo Borelli's avatar
Paolo Borelli committed
4
This is version 2.13.4 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
2.9.2  
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
2.9.2  
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
2.9.2  
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 25
    * Syntax highlighting
    * GNOME VFS support for remote files
Paolo Maggi's avatar
Paolo Maggi committed
26 27
    * Complete integration with the GNOME Environment
    * Search and Replace
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 Plugins system, with optional python support
Paolo Maggi's avatar
Paolo Maggi committed
31
    * Printing and Print Previewing Support
Paolo Borelli's avatar
Paolo Borelli committed
32

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

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

    * Word count
Paolo Borelli's avatar
Paolo Borelli committed
37 38 39
    * Spell checker
    * Change case of selected text
    * Sort
Paolo Maggi's avatar
Paolo Maggi committed
40 41 42 43
    * Tag list
    * Insert Date/Time
    * Shell output

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


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


The official web site is:

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

55
You can download the latest gedit tarball from the gnome ftp server:
Paolo Maggi's avatar
Paolo Maggi committed
56

57
    http://ftp.gnome.org/pub/GNOME/sources/gedit/
Paolo Maggi's avatar
Paolo Maggi committed
58 59 60

Information about gedit mailing lists can be found at

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


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

Paolo Borelli's avatar
Paolo Borelli committed
67 68 69
gedit requires GTK+-2.8.x, GtkSourceView 1.2.0 and GNOME 2.13.x libraries.
pygtk 2.8.x and gnome-python-desktop 2.13.x are required to enable python
plugins support.
Paolo Maggi's avatar
Paolo Maggi committed
70 71 72

Simple install procedure:

Paolo Borelli's avatar
Paolo Borelli committed
73 74
  % gzip -cd gedit-2.13.4.tar.gz | tar xvf - 	# unpack the sources
  % cd gedit-2.13.4				# change to the toplevel directory
Paolo Borelli's avatar
Paolo Borelli committed
75 76
  % ./configure					# run the `configure' script
  % make					# build gedit
Paolo Maggi's avatar
Paolo Maggi committed
77
  [ Become root if necessary ]
Paolo Borelli's avatar
Paolo Borelli committed
78
  % make install				# install gedit
Paolo Maggi's avatar
Paolo Maggi committed
79 80 81 82 83 84 85 86

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
87
(http://bugzilla.gnome.org, product gedit). You will need to create an
Paolo Maggi's avatar
Paolo Maggi committed
88 89 90
account for yourself.

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

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

Paolo Maggi's avatar
Paolo Maggi committed
94 95 96 97 98 99 100 101 102 103 104 105
* 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
106
  crash occurred.
Paolo Maggi's avatar
Paolo Maggi committed
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

* 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,
  it will be more useful if the stacktrace is produced running the test
  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.

Bug reports containing patches should include the PATCH keyword in their
keyword fields. 
  
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
mailing list. See also the file 'HACKING' for information about our
CVS guidelines and the file 'TODO' for a list of todos.



Paolo Borelli's avatar
2.9.6  
Paolo Borelli committed
138
  The gedit team.
Jose Maria Celorio's avatar
Jose Maria Celorio committed
139