Changeset 5485:bc8b07e9e95b for doc

Show
Ignore:
Timestamp:
2008-08-21 01:30:48 (4 months ago)
Author:
Rocco Rutte <pdmef@…>
Branch:
HEAD
Message:

Improve color/mono command synopsis.
Closes #2630.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/manual.xml.head

    r5472 r5485  
    18761876<para> 
    18771877<literallayout> 
    1878 Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> &lsqb; <emphasis>regexp</emphasis> &rsqb; 
     1878Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> 
     1879Usage: <literal>color</literal> (header &verbar; body) <emphasis>foreground</emphasis> <emphasis>background</emphasis> <emphasis>regexp</emphasis> 
    18791880Usage: <literal>color</literal> index <emphasis>foreground</emphasis> <emphasis>background</emphasis> <emphasis>pattern</emphasis> 
    18801881Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis> &lsqb; <emphasis>pattern</emphasis> ...  &rsqb; 
    … …  
    18901891 
    18911892<para> 
     1893<emphasis>header</emphasis> and <emphasis>body</emphasis> match <emphasis>regexp</emphasis> 
     1894in the header/body of a message, <emphasis>index</emphasis> matches <emphasis>pattern</emphasis> 
     1895(see <xref linkend="patterns"/>) in the message index. 
     1896</para> 
     1897 
     1898<para> 
    18921899<emphasis>object</emphasis> can be one of: 
    18931900</para> 
    18941901 
    18951902<para> 
    1896  
    18971903<itemizedlist> 
    1898 <listitem> 
    1899  
    1900 <para> 
    1901 attachment 
    1902 </para> 
    1903 </listitem> 
    1904 <listitem> 
    1905  
    1906 <para> 
    1907 body (match <emphasis>regexp</emphasis> in the body of messages) 
    1908 </para> 
    1909 </listitem> 
    1910 <listitem> 
    1911  
    1912 <para> 
    1913 bold (hiliting bold patterns in the body of messages) 
    1914 </para> 
    1915 </listitem> 
    1916 <listitem> 
    1917  
    1918 <para> 
    1919 error (error messages printed by Mutt) 
    1920 </para> 
    1921 </listitem> 
    1922 <listitem> 
    1923  
    1924 <para> 
    1925 header (match <emphasis>regexp</emphasis> in the message header) 
    1926 </para> 
    1927 </listitem> 
    1928 <listitem> 
    1929  
    1930 <para> 
    1931 hdrdefault (default color of the message header in the pager) 
    1932 </para> 
    1933 </listitem> 
    1934 <listitem> 
    1935  
    1936 <para> 
    1937 index (match <emphasis>pattern</emphasis> in the message index) 
    1938 </para> 
    1939 </listitem> 
    1940 <listitem> 
    1941  
    1942 <para> 
    1943 indicator (arrow or bar used to indicate the current item in a menu) 
    1944 </para> 
    1945 </listitem> 
    1946 <listitem> 
    1947  
    1948 <para> 
    1949 markers (the ``+'' markers at the beginning of wrapped lines in the pager) 
    1950 </para> 
    1951 </listitem> 
    1952 <listitem> 
    1953  
    1954 <para> 
    1955 message (informational messages) 
    1956 </para> 
    1957 </listitem> 
    1958 <listitem> 
    1959  
    1960 <para> 
    1961 normal 
    1962 </para> 
    1963 </listitem> 
    1964 <listitem> 
    1965  
    1966 <para> 
    1967 quoted (text matching <link linkend="quote-regexp">&dollar;quote&lowbar;regexp</link> in the body of a message) 
    1968 </para> 
    1969 </listitem> 
    1970 <listitem> 
    1971  
    1972 <para> 
    1973 quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis> (higher levels of quoting) 
    1974 </para> 
    1975 </listitem> 
    1976 <listitem> 
    1977  
    1978 <para> 
    1979 search (hiliting of words in the pager) 
    1980 </para> 
    1981 </listitem> 
    1982 <listitem> 
    1983  
    1984 <para> 
    1985 signature 
    1986 </para> 
    1987 </listitem> 
    1988 <listitem> 
    1989  
    1990 <para> 
    1991 status (mode lines used to display info about the mailbox or message) 
    1992 </para> 
    1993 </listitem> 
    1994 <listitem> 
    1995  
    1996 <para> 
    1997 tilde (the ``&tilde;'' used to pad blank lines in the pager) 
    1998 </para> 
    1999 </listitem> 
    2000 <listitem> 
    2001  
    2002 <para> 
    2003 tree (thread tree drawn in the message index and attachment menu) 
    2004 </para> 
    2005 </listitem> 
    2006 <listitem> 
    2007  
    2008 <para> 
    2009 underline (hiliting underlined patterns in the body of messages) 
    2010 </para> 
    2011 </listitem> 
    2012  
     1904<listitem><para>attachment</para></listitem> 
     1905<listitem><para>bold (hiliting bold patterns in the body of messages)</para></listitem> 
     1906<listitem><para>error (error messages printed by Mutt)</para></listitem> 
     1907<listitem><para>hdrdefault (default color of the message header in the pager)</para></listitem> 
     1908<listitem><para>indicator (arrow or bar used to indicate the current item in a menu)</para></listitem> 
     1909<listitem><para>markers (the ``+'' markers at the beginning of wrapped lines in the pager)</para></listitem> 
     1910<listitem><para>message (informational messages)</para></listitem> 
     1911<listitem><para>normal</para></listitem> 
     1912<listitem><para>quoted (text matching <link linkend="quote-regexp">&dollar;quote&lowbar;regexp</link> in the body of a message)</para></listitem> 
     1913<listitem><para>quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis> (higher levels of quoting)</para></listitem> 
     1914<listitem><para>search (hiliting of words in the pager)</para></listitem> 
     1915<listitem><para>signature</para></listitem><listitem><para>status (mode lines used to display info about the mailbox or message)</para></listitem> 
     1916<listitem><para>tilde (the ``&tilde;'' used to pad blank lines in the pager)</para></listitem> 
     1917<listitem><para>tree (thread tree drawn in the message index and attachment menu)</para></listitem> 
     1918<listitem><para>underline (hiliting underlined patterns in the body of messages)</para></listitem> 
    20131919</itemizedlist> 
    2014  
    20151920</para> 
    20161921 
    … …  
    20201925 
    20211926<para> 
    2022  
    20231927<itemizedlist> 
    2024 <listitem> 
    2025  
    2026 <para> 
    2027 white 
    2028 </para> 
    2029 </listitem> 
    2030 <listitem> 
    2031  
    2032 <para> 
    2033 black 
    2034 </para> 
    2035 </listitem> 
    2036 <listitem> 
    2037  
    2038 <para> 
    2039 green 
    2040 </para> 
    2041 </listitem> 
    2042 <listitem> 
    2043  
    2044 <para> 
    2045 magenta 
    2046 </para> 
    2047 </listitem> 
    2048 <listitem> 
    2049  
    2050 <para> 
    2051 blue 
    2052 </para> 
    2053 </listitem> 
    2054 <listitem> 
    2055  
    2056 <para> 
    2057 cyan 
    2058 </para> 
    2059 </listitem> 
    2060 <listitem> 
    2061  
    2062 <para> 
    2063 yellow 
    2064 </para> 
    2065 </listitem> 
    2066 <listitem> 
    2067  
    2068 <para> 
    2069 red 
    2070 </para> 
    2071 </listitem> 
    2072 <listitem> 
    2073  
    2074 <para> 
    2075 default 
    2076 </para> 
    2077 </listitem> 
    2078 <listitem> 
    2079  
    2080 <para> 
    2081 color<emphasis>x</emphasis> 
    2082 </para> 
    2083 </listitem> 
    2084  
     1928<listitem><para>white</para></listitem> 
     1929<listitem><para>black</para></listitem> 
     1930<listitem><para>green</para></listitem> 
     1931<listitem><para>magenta</para></listitem> 
     1932<listitem><para>blue</para></listitem> 
     1933<listitem><para>cyan</para></listitem> 
     1934<listitem><para>yellow</para></listitem> 
     1935<listitem><para>red</para></listitem> 
     1936<listitem><para>default</para></listitem> 
     1937<listitem><para>color<emphasis>x</emphasis></para> 
     1938</listitem> 
    20851939</itemizedlist> 
    2086  
    20871940</para> 
    20881941 
    … …  
    21371990<para> 
    21381991<literallayout> 
    2139 Usage: <literal>mono</literal> <emphasis>&lt;object&gt; &lt;attribute&gt;</emphasis> &lsqb; <emphasis>regexp</emphasis> &rsqb; 
     1992Usage: <literal>mono</literal> <emphasis>object</emphasis> <emphasis>attribute</emphasis> 
     1993Usage: <literal>mono</literal> (header &verbar; body) <emphasis>attribute</emphasis> <emphasis>regexp</emphasis> 
    21401994Usage: <literal>mono</literal> index <emphasis>attribute</emphasis> <emphasis>pattern</emphasis> 
    21411995Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis> &lsqb; <emphasis>pattern</emphasis> ...  &rsqb; 
    … …  
    21441998 
    21451999<para> 
    2146 where <emphasis>attribute</emphasis> is one of the following: 
    2147 </para> 
    2148  
    2149 <para> 
    2150  
     2000For <emphasis>object</emphasis>, see the color command. <emphasis>attribute</emphasis> 
     2001can be one of the following: 
     2002</para> 
     2003 
     2004<para> 
    21512005<itemizedlist> 
    2152 <listitem> 
    2153  
    2154 <para> 
    2155 none 
    2156 </para> 
    2157 </listitem> 
    2158 <listitem> 
    2159  
    2160 <para> 
    2161 bold 
    2162 </para> 
    2163 </listitem> 
    2164 <listitem> 
    2165  
    2166 <para> 
    2167 underline 
    2168 </para> 
    2169 </listitem> 
    2170 <listitem> 
    2171  
    2172 <para> 
    2173 reverse 
    2174 </para> 
    2175 </listitem> 
    2176 <listitem> 
    2177  
    2178 <para> 
    2179 standout 
    2180 </para> 
    2181 </listitem> 
    2182  
     2006<listitem><para>none</para></listitem> 
     2007<listitem><para>bold</para></listitem> 
     2008<listitem><para>underline</para></listitem> 
     2009<listitem><para>reverse</para></listitem> 
     2010<listitem><para>standout</para></listitem> 
    21832011</itemizedlist> 
    2184  
    21852012</para> 
    21862013