README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

README for eselect
===================

Authors
-------

See the AUTHORS file.

Documentation
-------------

See ``doc/``. Use ``make html`` for HTML versions.

Copyright
---------

eselect is Copyright (c) 2005-2011 Gentoo Foundation. This code is
distributed under the terms of the GNU General Public License version 2
or later.

Style Notes
-----------

* Always use ``[[ brackets ]]``, never `[ brackets ]`.
* Use quotes on variables where necessary.
* For all source files, the same indenting rules apply as for ebuilds:
  one tab per indent level, with each tab representing 4 places.
* Avoid lines wider than 79 positions.
* Public functions don't get the ``es_`` prefix, private functions do.
* eval is evil, so don't use it.
* Absolute paths to executables are not portable, so don't use them.