doc/html/cdl-guide/ref.display.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >display</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="The eCos Component Writer's Guide"
  20 HREF="cdl-guide.html"><LINK
  21 REL="UP"
  22 TITLE="CDL Language Specification"
  23 HREF="reference.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="description"
  26 HREF="ref.description.html"><LINK
  27 REL="NEXT"
  28 TITLE="doc"
  29 HREF="ref.doc.html"></HEAD
  30 ><BODY
  31 CLASS="REFENTRY"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >The <SPAN
  50 CLASS="APPLICATION"
  51 >eCos</SPAN
  52 > Component Writer's Guide</TH
  53 ></TR
  54 ><TR
  55 ><TD
  56 WIDTH="10%"
  57 ALIGN="left"
  58 VALIGN="bottom"
  59 ><A
  60 HREF="ref.description.html"
  61 ACCESSKEY="P"
  62 >Prev</A
  63 ></TD
  64 ><TD
  65 WIDTH="80%"
  66 ALIGN="center"
  67 VALIGN="bottom"
  68 ></TD
  69 ><TD
  70 WIDTH="10%"
  71 ALIGN="right"
  72 VALIGN="bottom"
  73 ><A
  74 HREF="ref.doc.html"
  75 ACCESSKEY="N"
  76 >Next</A
  77 ></TD
  78 ></TR
  79 ></TABLE
  80 ><HR
  81 ALIGN="LEFT"
  82 WIDTH="100%"></DIV
  83 ><H1
  84 ><A
  85 NAME="REF.DISPLAY"><SPAN
  86 CLASS="PROPERTY"
  87 >display</SPAN
  88 ></H1
  89 ><DIV
  90 CLASS="REFNAMEDIV"
  91 ><A
  92 NAME="AEN4249"
  93 ></A
  94 ><H2
  95 >Name</H2
  96 >Property <SPAN
  97 CLASS="PROPERTY"
  98 >display</SPAN
  99 >&nbsp;--&nbsp;Provide a short string describing this option.</DIV
 100 ><DIV
 101 CLASS="REFSYNOPSISDIV"
 102 ><A
 103 NAME="AEN4253"><H2
 104 >Synopsis</H2
 105 ><TABLE
 106 BORDER="5"
 107 BGCOLOR="#E0E0F0"
 108 WIDTH="70%"
 109 ><TR
 110 ><TD
 111 ><PRE
 112 CLASS="SYNOPSIS"
 113 >cdl_option &lt;name&gt; {
 114     display &lt;string&gt;
 115     &#8230;
 116 }</PRE
 117 ></TD
 118 ></TR
 119 ></TABLE
 120 ></DIV
 121 ><DIV
 122 CLASS="REFSECT1"
 123 ><A
 124 NAME="AEN4255"
 125 ></A
 126 ><H2
 127 >Description</H2
 128 ><P
 129 >Users can only be expected to manipulate configuration options
 130 sensibly if they are given sufficient information about these options.
 131 There are three properties which serve to explain an option in plain
 132 text: the <SPAN
 133 CLASS="PROPERTY"
 134 >display</SPAN
 135 > property gives a textual alias for an option,
 136 which is usually more comprehensible than something like
 137 <TT
 138 CLASS="LITERAL"
 139 >CYGPKG_LIBC_TIME_ZONES</TT
 140 >; the <SPAN
 141 CLASS="PROPERTY"
 142 >description</SPAN
 143 > property
 144 gives a longer description, typically a paragraph or so; the <SPAN
 145 CLASS="PROPERTY"
 146 >doc</SPAN
 147 >
 148 property specifies the location of additional on-line documentation
 149 related to a configuration option. In the context of a graphical tool
 150 the <SPAN
 151 CLASS="PROPERTY"
 152 >display</SPAN
 153 > string will be the primary way for users to identify
 154 configuration options; the <SPAN
 155 CLASS="PROPERTY"
 156 >description</SPAN
 157 > paragraph will be visible
 158 whenever the option is selected; the on-line documentation will only
 159 be accessed when the user explicitly requests it.</P
 160 ></DIV
 161 ><DIV
 162 CLASS="REFSECT1"
 163 ><A
 164 NAME="AEN4264"
 165 ></A
 166 ><H2
 167 >Example</H2
 168 ><TABLE
 169 BORDER="5"
 170 BGCOLOR="#E0E0F0"
 171 WIDTH="70%"
 172 ><TR
 173 ><TD
 174 ><PRE
 175 CLASS="PROGRAMLISTING"
 176 >cdl_option CYGNUM_KERNEL_SYNCH_MBOX_QUEUE_SIZE {
 177     display       "Message box queue size"
 178     flavor        data
 179     legal_values  1 to 65535
 180     default_value 10
 181     description   "
 182         This configuration option controls the number of messages
 183         that can be queued in a message box before a non-blocking
 184         put() operation will fail or a blocking put() operation will
 185         block. The cost in memory is one pointer per message box for
 186         each possible message."
 187 }</PRE
 188 ></TD
 189 ></TR
 190 ></TABLE
 191 ></DIV
 192 ><DIV
 193 CLASS="REFSECT1"
 194 ><A
 195 NAME="AEN4267"
 196 ></A
 197 ><H2
 198 >See Also</H2
 199 ><P
 200 >Properties <A
 201 HREF="ref.description.html"
 202 ><SPAN
 203 CLASS="PROPERTY"
 204 >description</SPAN
 205 ></A
 206 > and
 207 <A
 208 HREF="ref.doc.html"
 209 ><SPAN
 210 CLASS="PROPERTY"
 211 >doc</SPAN
 212 ></A
 213 >.</P
 214 ></DIV
 215 ><DIV
 216 CLASS="NAVFOOTER"
 217 ><HR
 218 ALIGN="LEFT"
 219 WIDTH="100%"><TABLE
 220 SUMMARY="Footer navigation table"
 221 WIDTH="100%"
 222 BORDER="0"
 223 CELLPADDING="0"
 224 CELLSPACING="0"
 225 ><TR
 226 ><TD
 227 WIDTH="33%"
 228 ALIGN="left"
 229 VALIGN="top"
 230 ><A
 231 HREF="ref.description.html"
 232 ACCESSKEY="P"
 233 >Prev</A
 234 ></TD
 235 ><TD
 236 WIDTH="34%"
 237 ALIGN="center"
 238 VALIGN="top"
 239 ><A
 240 HREF="cdl-guide.html"
 241 ACCESSKEY="H"
 242 >Home</A
 243 ></TD
 244 ><TD
 245 WIDTH="33%"
 246 ALIGN="right"
 247 VALIGN="top"
 248 ><A
 249 HREF="ref.doc.html"
 250 ACCESSKEY="N"
 251 >Next</A
 252 ></TD
 253 ></TR
 254 ><TR
 255 ><TD
 256 WIDTH="33%"
 257 ALIGN="left"
 258 VALIGN="top"
 259 ><SPAN
 260 CLASS="PROPERTY"
 261 >description</SPAN
 262 ></TD
 263 ><TD
 264 WIDTH="34%"
 265 ALIGN="center"
 266 VALIGN="top"
 267 ><A
 268 HREF="reference.html"
 269 ACCESSKEY="U"
 270 >Up</A
 271 ></TD
 272 ><TD
 273 WIDTH="33%"
 274 ALIGN="right"
 275 VALIGN="top"
 276 ><SPAN
 277 CLASS="PROPERTY"
 278 >doc</SPAN
 279 ></TD
 280 ></TR
 281 ></TABLE
 282 ></DIV
 283 ></BODY
 284 ></HTML
 285 >