File: sapphire.sgml

package info (click to toggle)
sapphire 0.15.8-9.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 448 kB
  • ctags: 850
  • sloc: cpp: 6,490; makefile: 102; sh: 77
file content (175 lines) | stat: -rw-r--r-- 5,988 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@
  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Chris</firstname>">
  <!ENTITY dhsurname   "<surname>Boyle</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>December 17, 2001</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>cmb@debian.org</email>">
  <!ENTITY dhusername  "Chris Boyle">
  <!ENTITY dhucpackage "<refentrytitle>SAPPHIRE</refentrytitle>">
  <!ENTITY dhpackage   "sapphire">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2001</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>minimal but configurable window manager</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <group choice="opt"><arg><option>-display <replaceable>displayname</replaceable></option></arg>
                          <arg><option>-version</option></arg></group>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

    <para><command>&dhpackage;</command> is a minimal but configurable
      window manager for X11R6. It supports themes in the form of X resource
      files, and has a customisable menu.</para>

    <para>The Debian version receives Debian menu entries automatically
      in a "Debian" submenu by default, you can add entries
      specifically to sapphire (in the rest of the menu) in the
      <filename>default-menu</filename> file. For more information, see
      update-menus (1) and the FILES section below.</para>

    <para>Users can also set their own options in
      <filename>$HOME/.sapphire/wmconf</filename> (an X resource file).</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>-display <replaceable>displayname</replaceable></option></term>
        <listitem>
          <para>Use the X-server display 'displayname'.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-version</option></term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>FILES</title>

    <variablelist>
      <varlistentry>
         <term><filename>/etc/X11/sapphire/menu/default-menu</filename></term>
         <listitem><para>menu entries specific to sapphire (you can edit this one, it's 
           a conffile)</para></listitem>
      </varlistentry>
      <varlistentry>
         <term><filename>/etc/X11/sapphire/menu/menudefs.hook</filename></term>
         <listitem><para>Debian menu entries in sapphire's format, not 
           read directly, do not edit (edit <filename>default-menu</filename>
           instead)</para></listitem>
      </varlistentry>
      <varlistentry>
        <term><filename>/etc/X11/sapphire/menu/default</filename></term>
        <listitem><para>this menu file is the one sapphire actually reads, it is
          automatically generated from the other two by update-menus, do not edit
          (edit <filename>default-menu</filename> instead)</para></listitem>
      </varlistentry>
      <varlistentry>
         <term><filename>$HOME/.sapphire/wmconf</filename></term>
         <listitem><para>user-specific options</para></listitem>
      </varlistentry>
      <varlistentry>
         <term><filename>/usr/share/sapphire/themes</filename></term>
         <listitem><para>themes directory, all of the above may refer to themes from
           here (the files themselves are X resource files)</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>HISTORY</title>

    <para>Sapphire was originally developed from Decklin Foster's aewm, and
      also uses some code from Blackbox (for gradients).</para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>XFree86 (1), update-menus (1).</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the <acronym>GNU</acronym> Free Documentation
      License, Version 1.1 or any later version published by the Free
      Software Foundation; with no Invariant Sections, no Front-Cover
      Texts and no Back-Cover Texts.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->