From 02d414b3ab447e637fef776e387aa5a07293738a Mon Sep 17 00:00:00 2001
From: Robin Haberkorn <robin.haberkorn@googlemail.com>
Date: Tue, 2 Jun 2015 15:38:00 +0200
Subject: added <FG> command and special Q-Register "$" to set and get the
 current working directory

 * FG stands for "Folder Go"
 * FG behaves similar to a Unix shell `cd`.
   Without arguments, it changes to the $HOME directory.
 * The $HOME directory was previously only used by $SCITECOCONFIG on Unix.
   Now it is documented on its own, since the HOME directory should also
   be configurable on Windows - e.g. to adapt SciTECO to a MinGW or Cygwin
   installation.
   HOME is initialized just like the other environment variables.
   This also means that now, the $HOME Q-Register is always defined
   and can be used by platform-agnostic macros.
 * FG uses a new kind of tab-completion: for directories only.
   It would be annoying to complete the FG command after every
   directory, so this tab-completion does not close the command
   automatically. Theoretically, it would be possible to close
   the command after completing a directory with no subdirectories,
   but this is not supported currently.
 * Filename arguments are no longer completed with " " if {} escaping
   is in place as this brings no benefit. Instead no completion character
   is inserted for this escape mode.
 * "$" was mapped to the current directory to support an elegant way to
   insert/get the current directory.
   Also this allows the idiom "[$ FG...new_dir...$ ]$" for changing
   the current directory temporarily.
 * The Q-Register stack was extended to support restoring the string
   part of special Q-Registers (that overwrite the default functionality)
   when using the "[$" and "]$" commands.
 * fixed minor typos (american spelling)
---
 doc/sciteco.7.template | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'doc/sciteco.7.template')

diff --git a/doc/sciteco.7.template b/doc/sciteco.7.template
index 4fccd33..8272b08 100644
--- a/doc/sciteco.7.template
+++ b/doc/sciteco.7.template
@@ -443,6 +443,13 @@ Fully completed filenames terminate the string argument,
 except if the \(lq{\(rq terminator is used.
 T}
 T{
+Auto complete directory
+T};9;^I, Tab;T{
+Directory arguments
+T};T{
+Auto complete directory beginning at the start of the argument.
+T}
+T{
 Auto complete symbol
 T};9;^I, Tab;T{
 Scintilla symbol arguments
@@ -1022,6 +1029,26 @@ temporarily:
 [* ! ...change current buffer... ! ]*
 .EE
 .TP
+.BR $ " (dollar)"
+The process' current working directory (string part).
+Its numeric part is currently unused.
+The working directory will always be returned as an
+absolute path with normalized forward-slash directory
+separators.
+It is possible to set this register using the \fB^U\fP or
+\fBEU\fP commands which will change the current working
+directory in a manner similar to the \fBFG\fP command.
+This allows you to change the current directory temporarily
+with the following idiom:
+.EX
+[$ ! ...change current directory... ! ]$
+.EE
+As with \fBFG\fP, relative directories may be specified
+but querying \(lq$\(rq will still return an absolute path.
+The \(lq$\(rq register may also be edited but changing its
+string contents this way has no effect on the current
+working directory.
+.TP
 .BR $ " (Escape)"
 Command-line replacement register.
 Its integer part is unused.
-- 
cgit v1.2.3