eproject.txt

   1
   2                            eproject
   3                            ========
   4
   5                -- project workspaces for emacs --
   6
   7   A project in this sense is:
   8   * A set of files that you wish to operate with, and
   9   * A set of commands bound to key shorcuts and menu entries
  10
  11   In particular eproject lets you switch between projects as easily as
  12   between files.
  13
  14
  15
  16                              Keys
  17                              ====
  18
  19   Global:
  20
  21                            F5 : Toggle project setup
  22                       Ctrl-F5 : Browse project directory in dired
  23                      Alt-Left : Previous file
  24                     Alt-Right : Next file
  25
  26   In the project setup:
  27
  28                    Arrow keys : Navigate
  29                        Return : Open project, file, tool
  30                      <letter> : Quick search
  31                  Alt-<letter> : Activate link
  32                      Spacebar : Enter edit mode
  33                        Escape : Quit edit mode
  34
  35   In dired:
  36
  37                             a : Add file(s) to the project
  38
  39
  40
  41                              Setup
  42                              =====
  43
  44   Projects:
  45   ---------
  46
  47   This is the global project list. You can open and close projects,
  48   and add new or already existing ones to the list.
  49
  50
  51   Files:
  52   ------
  53
  54   Files are added to the project simply when they are first
  55   visited. Similar they are removed then they get killed.  New files
  56   are inserted after the one that was last viewed.
  57
  58
  59   Tools:
  60   ------
  61
  62   Here you can enter some shell command lines with tools that you wish
  63   to have at hand, and optionally bind them to key shortcuts.  The
  64   tools will show up in the menu also.
  65
  66   There are two options that can be put in front of commands:
  67
  68     -e <emacs-command>    run lisp command or sexp
  69     -in <directory> ...   run command in specified directory.
  70      (Relative paths refer to the project directory)
  71
  72   A new project is initialized with default tool commands. If you wish
  73   to have a different default set, please edit 'prj-default-config' in
  74   'eproject.el' near the top.
  75
  76
  77   Settings:
  78   ---------
  79
  80   Currently there is only 'project-name'.  If you add a new project,
  81   the name is initialized to the directory name, but you can change it
  82   to whatever you want.
  83
  84
  85   Edit Mode:
  86   ----------
  87
  88   In the project setup, hit the the spacebar to enter edit mode.  You
  89   can edit pretty much everything except it has little effect to
  90   change the name of a project other than the current one.
  91
  92   Hit escape to quit the edit mode. Any changes to the configuration
  93   are saved automatically when the project is closed.
  94
  95
  96
  97                              Usage
  98                              =====
  99
 100   To load eproject, add this line to your ~/.emacs:
 101
 102       (load-file "/path/to/eproject.el")
 103
 104   eproject will automatically start up with the last recently used
 105   project. It will also restore the frame size and position.  You can
 106   start emacs with a specific project from the command line using:
 107
 108       emacs -project <projectname>
 109
 110
 111   eproject commands:
 112   ------------------
 113
 114   projects:
 115
 116     eproject-add
 117     eproject-remove
 118     eproject-open
 119     eproject-close
 120     eproject-help
 121
 122   files:
 123
 124     eproject-addfile
 125     eproject-removefile
 126     eproject-visitfile
 127     eproject-prevfile (M-left)
 128     eproject-nextfile (M-right)
 129
 130   setup:
 131
 132     eproject-setup
 133     eproject-setup-toggle (f5)
 134     eproject-setup-quit
 135     eproject-edit
 136     eproject-edit-quit
 137     eproject-save
 138     eproject-revert
 139
 140   other:
 141
 142     eproject-grep              : run grep on the project files)
 143     eproject-dired (C-F5)      : dired project (add files with 'a')
 144     eproject-killtool          : kill compiler etc.
 145     eproject-killbuffers       : kill all buffers except project files
 146
 147
 148
 149                             License
 150                             =======
 151
 152   eproject 0.2
 153   Copyright (C) 2008 grischka@users.sourceforge.net
 154
 155   This program is free software, released under the GNU General Public
 156   License (GPL), Version 2.  For details see:
 157
 158       http://www.fsf.org/licenses/gpl.html
 159
 160   This program is distributed in the hope that it will be useful, but
 161   WITHOUT ANY WARRANTY; without even the implied warranty of
 162   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 163   General Public License for more details.
 164
 165   Jan 17, 2008 -- grischka