components/x11/winsysck/src/winsysck.man

   1 .\" Copyright (c) 1990, 2014, Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .TH winsysck 1 "2 May 2014"
  22 .IX "winsysck" "" "\f3winsysck\f1(1) \(em check window protocols" ""
  23 .IX "window" "check" "window" "check system protocols \(em \f3winsysck\f1(1)" ""
  24 .SH NAME
  25 winsysck \- check which window system protocols are available
  26 .SH SYNOPSIS
  27 .B winsysck
  28 [
  29 .B \-va
  30 ] [
  31 .BI \-display " displaystring"
  32 ] [
  33 .BI \-timeout " seconds"
  34 ]
  35 .I protocol
  36 [.\|.\|.]
  37 .SH DESCRIPTION
  38 The
  39 .B winsysck
  40 command determines if the specified window system \fIprotocol\fP
  41 is available to the user.  By default, the
  42 .B winsysck
  43 command exits as soon as the first available
  44 .I protocol
  45 is found, although this behaviour can be modified by the
  46 .B -a
  47 option (see below).
  48 .SH OPTIONS
  49 The following options can be used to modify the behaviour of the
  50 .B winsysck
  51 command.
  52 .TP
  53 .B \-a
  54 Continue to check the availability of the specified
  55 .IR protocol s
  56 even after determining that one or more previously specified
  57 .IR protocol s
  58 are available.  This is not particularly useful without the
  59 .B \-v
  60 option (see below).
  61 .TP
  62 .B \-v
  63 Print the name of the first available
  64 .I protocol
  65 on the standard output.  When combined with the
  66 .B \-a
  67 option (see above), print the name of all available
  68 .IR protocol s
  69 on the standard output, separated by newlines.
  70 .TP
  71 .BI \-display " displaystring"
  72 Use the display
  73 .I displaystring
  74 when trying to determine if the
  75 .B x11
  76 .I protocol
  77 is available.
  78 .TP
  79 .BI \-timeout \ seconds
  80 The
  81 .I timeout
  82 option sets the number of
  83 .I seconds
  84 before the winsysck will time out.
  85 .SH "KNOWN PROTOCOLS"
  86 The following are known values for
  87 .IR protocol .
  88 .TP
  89 .B x11
  90 Determines if a connection can be made using the X11 Window
  91 System protocol.
  92 .TP
  93 .B news
  94 Determines if a connection can be made using the
  95 Network-extensible Window System protocol.
  96 .TP
  97 .B x11news
  98 Determines if connections can be made to an X11/NeWS server.
  99 In addition to being able to establish connections using both
 100 the X11 Window System and Network-extensible Window System protocols,
 101 this requires that these two connections actually interact with
 102 the same window server.
 103 .TP
 104 .B sunview
 105 Determines if connections can be made using the SunView Window
 106 System protocol.
 107 .SH EXAMPLES
 108 .LP
 109 Determine if an X11 Window System connection can be made:
 110 .LP
 111 .RS
 112 .nf
 113 .ft B
 114 example% if winsysck x11 ; then ...
 115 .ft P
 116 .fi
 117 .RE
 118 .LP
 119 Determine if an X11 Window System connection can be made to the
 120 display \*(lqdisplayhost:0.0\*(rq:
 121 .LP
 122 .RS
 123 .nf
 124 .ft B
 125 example% if winsysck -display displayhost:0.0 x11 ; then ...
 126 .ft P
 127 .fi
 128 .RE
 129 .LP
 130 Print the known protocols which are available:
 131 .LP
 132 .RS
 133 .nf
 134 .ft B
 135 example% winsysck -v -a x11 news x11news sunview
 136 .ft P
 137 .fi
 138 .RE
 139 .LP
 140 Print which window system should be used, given the preference
 141 for NeWS over SunView, and X11/NeWS over NeWS:
 142 .LP
 143 .RS
 144 .nf
 145 .ft B
 146 example% winsysck -v x11news news sunview
 147 .ft P
 148 .fi
 149 .RE
 150 .SH "SEE ALSO"
 151 .BR Xserver (1)
 152 .SH LIMITATIONS
 153 .LP
 154 There is no way to determine whether a SunView connection is
 155 actually connected to an X11/NeWS server with SunView
 156 compatibility enabled or to a SunView server.
 157 .LP
 158 winsysck assumes that no system running this version of __distroname__
 159 could be running SunView, NeWS, or X11/NeWS, so doesn't bother checking
 160 for anything but X11.
 161 .SH BUGS
 162 .LP
 163 None known.
 164 .SH DIAGNOSTICS
 165 Exit status is 0 if any
 166 .IR protocol s
 167 are available,
 168 1 if none are available, 2 for usage errors.