[PATCH:xorg-docs 3/4] X.man: document protocol/ syntax in display string

[Jeremy Huddleston Sequoia]

Should we also mention the extension that was added for launchd support where we DISPLAY=<absolute path to socket>[.<screen number>]

> On Oct 27, 2015, at 19:45, Alan Coopersmith <alan.coopersmith at oracle.com> wrote:
> 
> See http://www.x.org/releases/X11R7.7/doc/libX11/libX11/libX11.html#Opening_the_Display
> 
> Signed-off-by: Alan Coopersmith <alan.coopersmith at oracle.com>
> ---
> man/X.man |   25 ++++++++++++++++++++++---
> 1 file changed, 22 insertions(+), 3 deletions(-)
> 
> diff --git a/man/X.man b/man/X.man
> index d07e69e..a4f4614 100644
> --- a/man/X.man
> +++ b/man/X.man
> @@ -1,4 +1,4 @@
> -.\" t
> +'\" t
> .\"
> .\" Copyright (c) 1994, 2004  The Open Group
> .\" Copyright \(co 2000  The XFree86 Project, Inc.
> @@ -165,15 +165,34 @@ form:
> .RS
> \fIhostname:displaynumber.screennumber\fP
> .RE
> +or
> +.RS
> +\fIprotocol/hostname:displaynumber.screennumber\fP
> +.RE
> .sp
> This information is used by the application to determine how it should
> connect to the server and which screen it should use by default
> (on displays with multiple monitors):
> .TP 8
> +.I protocol
> +The \fIprotocol\fP specifies the protocol to use for communication.
> +Exactly which protocols are supported is platform dependent, but most
> +commonly supported ones are:
> +.TS
> +l l.
> +tcp     TCP over IPv4 or IPv6
> +inet    TCP over IPv4 only
> +inet6   TCP over IPv6 only
> +unix    UNIX Domain Sockets (same host only)
> +local   Platform preferred local connection method
> +.TE
> +If the protocol is not specified, Xlib uses whatever it believes is the
> +most efficient transport.
> +.TP 8
> .I hostname
> The \fIhostname\fP specifies the name of the machine to which the display is
> -physically connected.  If the hostname is not given, the most efficient way of
> -communicating to a server on the same machine will be used.
> +physically connected.  If the hostname is not given, a connection to a server
> +on the same machine will be used.
> .TP 8
> .I displaynumber
> The phrase "display" is usually used to refer to a collection of monitors that
> -- 
> 1.7.9.2
> 
> _______________________________________________
> xorg-devel at lists.x.org: X.Org development
> Archives: http://lists.x.org/archives/xorg-devel
> Info: http://lists.x.org/mailman/listinfo/xorg-devel

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4109 bytes
Desc: not available
URL: <http://lists.x.org/archives/xorg-devel/attachments/20151028/3f2ab356/attachment.bin>