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