bermudi/diakonos
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Added documentation for column markers and external programs (shelling out).

Browse source
This commit is contained in:
Pistos 2009-03-29 12:54:05 -04:00
parent 9d25757df7
commit 36a291120f
2 changed files with 75 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
help/column-markers.dhf Normal file
View file

@ -0,0 +1,15 @@
# Column Markers
You can define column markers using the view.column_markers.* settings. You
might use a column marker as a visual cue to help you not exceed a certain line
length. You can set up as many column markers as you like.
## Example of a column marker
view.column_markers.margin.column 80
view.column_markers.margin.format 9
Adding these lines to your configuration would set up a column marker named
'margin'. The name 'margin' is arbitrary; use whatever string you want for your
markers. The 'margin' marker would highlight the 80th column using the format
code 9 (white on red in the default 16-colour configuration).

60
help/shell.dhf Normal file
View file

@ -0,0 +1,60 @@
# External Programs
Diakonos has several functions available that you can map to keys in order to
execute external programs, scripts and applications: shell, execute and
pasteShellResult. Each one takes an optional string argument, which is the
shell command to execute. If no argument is given, the user is prompted for
the command to execute.
shell will run the command and show the results in a new buffer. execute will
run the command, and allow you to interact with it, but discard the results.
pasteShellResult will paste the command's results at the current cursor
location.
The shell command also takes an optional second parameter which lets you
specify the file to which the shell results are to be written.
Press <F2> to specify an arbitrary command to run with 'shell'.
Press <F8> to specify an arbitrary command to run with 'execute'.
## Shell Variables
The command strings to these commands given can contain any of the following
variables:
$f the current buffer's filepath
$d the current buffer's directory
$F all current buffer filepaths, space-separated
$i a string obtained from user input
$c temp file containing current clipboard text
$k temp file containing current klipper (KDE clipboard) text
$s temp file containing currently selected text
## Examples
The following examples are found in the default configuration file.
key ctrl+alt+c shell "ruby -c $f"
Press <Ctrl-Alt-C> to check the Ruby syntax of the current buffer.
key esc d shell "diff -U 5 -w -b $c $s", "clipboard.diff"
Press <Alt-D> to diff the current clipboard text against the currently selected
text, and write the result to a file named clipboard.diff.
key esc l execute "aspell check $f"
Press <Alt-L> to interactively spell check the current file with the aspell
program. (This keychord is not active in the default configuration.)
key f9 shell "cd $d; git diff --ignore-space-change -- $f", 'git.diff'
Press <F9> to see all changes made to the current buffer that have not been
committed to the git repository yet.
Tags: shell system exec execute spawn spawning executing shelling out external program programs application app apps applications variable variables substitute substitution spell spelling check git diff difference