bug#3048: emacsclient help text clarification

bug#3048: emacsclient help text clarification

[Brandon Maister]

[-- Attachment #1: Type: text/plain, Size: 606 bytes --]

Hey I was trying to use the new emacsclient -a option, and it took me
a few minutes to figure out that I was supposed to put `-a emacs' in
there. (instead of just emacsclient -a myfile)

It seems like other people might be less confused in the future if you
were to add the line:

         ARGUMENTS required for long OPTIONS are required for short OPTIONS too.

to the `emacsclient --help' output. So I did that and am sending it to
you. (I couldn't figure out what the capitalization is supposed to
mean, so that might look insane to you, but other than that.)

Thanks for a great thing,
brandon maister

[-- Attachment #2: echelp --]
[-- Type: application/octet-stream, Size: 981 bytes --]

Usage: emacsclient [OPTIONS] FILE...
Tell the Emacs server to visit the specified files.
Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.
ARGUMENTS required for long OPTIONS are required for short OPTIONS too.

The following OPTIONS are accepted:
-V, --version		Just print version info and return
-H, --help    		Print this usage information message
-nw, -t, --tty 		Open a new Emacs frame on the current terminal
-c, --create-frame    	Create a new frame instead of trying to
			use the current Emacs frame
-e, --eval    		Evaluate the FILE arguments as ELisp expressions
-n, --no-wait		Don't wait for the server to return
-d, --display=DISPLAY	Visit the file in the given display
-s, --socket-name=FILENAME
			Set filename of the UNIX socket for communication
-f, --server-file=FILENAME
			Set filename of the TCP authentication file
-a, --alternate-editor=EDITOR
			Editor to fallback to if the server is not running

Report bugs to bug-gnu-emacs@gnu.org.

bug#3048: marked as done (emacsclient help text clarification)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 856 bytes --]


Your message dated Sun, 19 Apr 2009 22:55:51 -0400
with message-id <874owkjao8.fsf@cyd.mit.edu>
and subject line Re: emacsclient help text clarification
has caused the Emacs bug report #3048,
regarding emacsclient help text clarification
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
3048: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=3048
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 5210 bytes --]

[-- Attachment #2.1.1: Type: text/plain, Size: 606 bytes --]

Hey I was trying to use the new emacsclient -a option, and it took me
a few minutes to figure out that I was supposed to put `-a emacs' in
there. (instead of just emacsclient -a myfile)

It seems like other people might be less confused in the future if you
were to add the line:

         ARGUMENTS required for long OPTIONS are required for short OPTIONS too.

to the `emacsclient --help' output. So I did that and am sending it to
you. (I couldn't figure out what the capitalization is supposed to
mean, so that might look insane to you, but other than that.)

Thanks for a great thing,
brandon maister

[-- Attachment #2.1.2: echelp --]
[-- Type: application/octet-stream, Size: 981 bytes --]

Usage: emacsclient [OPTIONS] FILE...
Tell the Emacs server to visit the specified files.
Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.
ARGUMENTS required for long OPTIONS are required for short OPTIONS too.

The following OPTIONS are accepted:
-V, --version		Just print version info and return
-H, --help    		Print this usage information message
-nw, -t, --tty 		Open a new Emacs frame on the current terminal
-c, --create-frame    	Create a new frame instead of trying to
			use the current Emacs frame
-e, --eval    		Evaluate the FILE arguments as ELisp expressions
-n, --no-wait		Don't wait for the server to return
-d, --display=DISPLAY	Visit the file in the given display
-s, --socket-name=FILENAME
			Set filename of the UNIX socket for communication
-f, --server-file=FILENAME
			Set filename of the TCP authentication file
-a, --alternate-editor=EDITOR
			Editor to fallback to if the server is not running

Report bugs to bug-gnu-emacs@gnu.org.

[-- Attachment #3: Type: message/rfc822, Size: 1317 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: Brandon Maister <bwmaister@gmail.com>
Cc: 3048-done@emacsbugs.donarmstrong.com
Subject: Re: emacsclient help text clarification
Date: Sun, 19 Apr 2009 22:55:51 -0400
Message-ID: <874owkjao8.fsf@cyd.mit.edu>

> Hey I was trying to use the new emacsclient -a option, and it took me
> a few minutes to figure out that I was supposed to put `-a emacs' in
> there. (instead of just emacsclient -a myfile)

I've tweaked the --help message so that this should be a little more
obvious.