README -- improved documentation.
configure -- hmm... this should be removed from CVS, but... later.
This commit is contained in:
mishoo
parent
63b0b60a2d
commit
3bb76f5a79
133
README
133
README
|
|
@ -1,4 +1,4 @@
|
|||
gmrun 0.1.1
|
||||
gmrun 0.6.0 http://www.sourceforge.net/projects/gmrun
|
||||
------------
|
||||
|
||||
Short GtkEntry for file autocompletion + main.cc that does the
|
||||
|
|
@ -19,6 +19,40 @@ send postcards to:
|
|||
This program falls under the GNU General Public License version 2 or above.
|
||||
|
||||
|
||||
Features
|
||||
---------
|
||||
|
||||
* Tilda completion (~/ <==> $HOME/)
|
||||
|
||||
* Completion works for separate words (e.g. you can type em<TAB> which
|
||||
turns to emacs, type a SPACE, and write the file you want to open using
|
||||
completion).
|
||||
|
||||
* I added history capability (limited to 20 entries, change history.cc for
|
||||
more, #define HIST_MAX_SIZE). History is maintained in the file "
|
||||
~/.gmrun_history ".
|
||||
|
||||
CHANGED (since 0.5.3, I think..) -- new config file parameter: History.
|
||||
|
||||
* CTRL-Enter runs the command in a terminal. CTRL-Enter without any
|
||||
command starts a new terminal.
|
||||
|
||||
* New configuration file: ~/.gmrunrc or /usr/local/share/gmrun/gmrunrc.
|
||||
Check one of them, configuration is very simple. From that file you
|
||||
can change window position and width, history size, terminal, URL
|
||||
handlers, etc.
|
||||
|
||||
* You can use CTRL-R / CTRL-S to search through history, much like in bash
|
||||
or Emacs. Also, pressing "!" as the first character enters some special
|
||||
search mode, finding those history entries that begin with the entered
|
||||
text.
|
||||
|
||||
* URL handlers (added in 0.6.0). Nice feature, allowing you to enter
|
||||
lines like "http://www.google.com" to start your favorite browser on
|
||||
www.google.com. The URL-s are configurable from the configuration
|
||||
file, in a simple manner (I hope..).
|
||||
|
||||
|
||||
For code critics
|
||||
-----------------
|
||||
|
||||
|
|
@ -64,9 +98,68 @@ Compilation, installation
|
|||
Note that if you're using sawfish you have other ways to customize your
|
||||
keyboard, through the control panel.
|
||||
|
||||
For another window managers you gonna have to find a way to bind this
|
||||
program to a key combination; otherwise it wouldn't be much help... (I
|
||||
coded it exactly to get rid of the mouse-time-wasting-walking).
|
||||
E.g. for IceWM (my favorite, at this time) you edit ~/.icewm/preferences
|
||||
and add a line like:
|
||||
|
||||
KeySysRun="Alt+Ctrl+Shift+Enter"
|
||||
|
||||
Tips and tricks (hope that doesn't sound MS-ish...)
|
||||
----------------------------------------------------
|
||||
|
||||
1. Everything that doesn't start with "/" or "~" gets completed from $PATH
|
||||
environment var. More exactly, all files from $PATH directories are
|
||||
subjects to completion (even if they are NOT executables; this is a
|
||||
bug, but I'm afraid I'm not willing to fix it).
|
||||
|
||||
Pressing TAB once when no text is entered opens the completion window,
|
||||
which will contain ALL files under $PATH.
|
||||
|
||||
2. For instance you use TAB to complete from "nets" to "netscape-navigator".
|
||||
A small window appears, allowing you to select from:
|
||||
|
||||
- netscape
|
||||
- netscape-communicator
|
||||
- netscape-navigator
|
||||
- netstat
|
||||
|
||||
That is because all these executables have the same prefix, "nets". You
|
||||
type TAB twice to get to the third element ("netscape-navigator"). Now,
|
||||
if you want to add a parameter such as "-url http://blah.blah.org" you
|
||||
can press SPACE (the list disappears, and a SPACE is inserted after the
|
||||
netscape-navigator).
|
||||
|
||||
3. If you accidentally pressed TAB more than you wanted (in that small
|
||||
window, described above) you can use UP / DOWN arrows to select the right
|
||||
completion.
|
||||
|
||||
4. - ESC closes the completion window, leaving the selected text in the entry.
|
||||
- HOME / END - the same, but clears the selection.
|
||||
- SPACE - the same, but clears the selection and appends one space.
|
||||
- Pressing ENTER (anytime) runs the command that is written in the entry.
|
||||
- Pressing CTRL+Enter (anytime) runs the command in a terminal (check your
|
||||
configuration file. But if the entry is empty (no text is present, or
|
||||
only whitespaces) then a fresh terminal will be started.
|
||||
|
||||
5. Suppose you use CTRL-R to search backwards through history. If,
|
||||
accidentally, you skipped the line that you're interested in, you can use
|
||||
CTRL-S to search forward. This is more awesome than in bash :) It
|
||||
basically acts like a filter on history, for which you use CTRL-R instead
|
||||
of UP arrow, and CTRL-S instead of DOWN arrow.
|
||||
|
||||
The same if you search something with "!": only lines that BEGIN with the
|
||||
entered text are matching, but you can reverse the search order using
|
||||
CTRL-R / CTRL-S. Very flexible approach.
|
||||
|
||||
|
||||
Bugs
|
||||
-----
|
||||
|
||||
* It gets pretty slow... Maybe I should consider writting it in ANSI-C,
|
||||
but.... maybe not.
|
||||
|
||||
* Writting this README took me more time than writting the program.
|
||||
|
||||
* As I mentioned before, the code is written in C++, although GTK+ is a
|
||||
|
|
@ -76,17 +169,15 @@ Bugs
|
|||
free to do it, but I fear the code should be rewritten (almost) from
|
||||
scratch.
|
||||
|
||||
* Documentation is inexistent (however, it would be useless).
|
||||
* Documentation is inexistent (except this file) (however, it would be
|
||||
quite useless).
|
||||
|
||||
Should you have any problems mail me a detailed description; please put
|
||||
the text "ignore_me" in the subject line, for easy message filtering. :)
|
||||
(just kidding...)
|
||||
(just kidding... I would gladely help if I can).
|
||||
|
||||
Never send me cores! My mail box is limited to 4 Mb. Use instead:
|
||||
|
||||
$ cat core > /dev/null
|
||||
|
||||
if you feel like you *have* to send it somewhere.. :)
|
||||
* Actually I worked more than 2 hours. Anyway, the completion code took
|
||||
about 2-3 h to design and implement.
|
||||
|
||||
|
||||
Disclaimer
|
||||
|
|
@ -101,29 +192,3 @@ Disclaimer
|
|||
|
||||
|
||||
(: END OF TERMS AND CONDITIONS :)
|
||||
|
||||
|
||||
Changes since writing this file:
|
||||
---------------------------------
|
||||
|
||||
* Tilda completion (~/ <==> $HOME/)
|
||||
|
||||
* Completion works for separate words (e.g. you can type em<TAB> which
|
||||
turns to emacs, type a SPACE, and write the file you want to open using
|
||||
completion).
|
||||
|
||||
* I added history capability (limited to 20 entries, change history.cc for
|
||||
more, #define HIST_MAX_SIZE). History is maintained in the file "
|
||||
~/.gmrun_history ".
|
||||
|
||||
* Actually I worked more than 2 hours. Anyway, the completion code took
|
||||
about 2-3 h to design and implement.
|
||||
|
||||
* CTRL-Enter runs the command in a terminal. CTRL-Enter without any
|
||||
command starts a new terminal.
|
||||
|
||||
* New configuration file: ~/.gmrunrc or /usr/local/share/gmrun/gmrunrc.
|
||||
Check one of them, configuration is very simple. From that file you
|
||||
can change window position and width, history size, terminal.
|
||||
|
||||
These changes should appear in the ChangeLog.
|
||||
|
|
|
|||
Loading…
Reference in New Issue