I suggest the attached improvement to the starting.txt helpfile in order
to clarify the relation between
vim -?
vim -h
vim --help
at least in GTK2/GNOME2 builds.
I have checked that this describes the behaviour of the current Vim
7.3.712 with GTK2-GNOME GUI; I haven't tested without GNOME, or with the
(now obsolete) GTK1. What I called GTK might perhaps apply only to GNOME
(and even GTK2/GNOME2?) versions.
Best regards,
Tony.
--
CRONE: Who sent you?
ARTHUR: The Knights Who Say Ni!
CRONE: Aaaagh! (she looks around in rear) No! We have no shrubberies
here.
"Monty Python and the Holy Grail" PYTHON (MONTY)
PICTURES LTD
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
# HG changeset patch
# Parent 1f9088968f422149e09175e30df4b98cf1477f91
# User Tony Mechelynck <antoine.mechely...@gmail.com>
Improve help for --help
diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt
--- a/runtime/doc/starting.txt
+++ b/runtime/doc/starting.txt
@@ -120,20 +120,34 @@ use an alias instead. For example: >
*startup-options*
The option arguments may be given in any order. Single-letter options can be
combined after one dash. There can be no option arguments after the "--"
argument.
On VMS all option arguments are assumed to be lowercase, unless preceded with
a slash. Thus "-R" means recovery and "-/R" readonly.
---help *-h* *--help*
--h Give usage (help) message and exit. {not in Vi}
+-h Give usage (help) message and exit. {not in Vi} *-h*
See |info-message| about capturing the text.
+-? *-?*
+ Give GTK-specific help, then exit. {only in GTK versions}
+ See |info-message| about capturing the text.
+
+--help {not in Vi} *--help*
+ * GTK versions: give both Vim help (as with -h) and GTK help
+ (as with -?), then exit
+ * Other versions: same as |-h|
+ See |info-message| about capturing the text.
+
+ Note: If the X11 server is not reachable, both -? and --help
+ will (instead of the GTK-specific help) give error |E233|
+ followed by the |hit-enter-prompt|, and start the editor in
+ the terminal.
+
*--version*
--version Print version information and exit. Same output as for
|:version| command. {not in Vi}
See |info-message| about capturing the text.
*--noplugin*
--noplugin Skip loading plugins. Resets the 'loadplugins' option.
{not in Vi}
