Gentoo Archives: gentoo-doc-cvs

From: Jan Kundrat <jkt@×××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: gpm.xml
Date: Tue, 26 Jul 2005 17:57:22
Message-Id: 200507261757.j6QHv5Gt010324@robin.gentoo.org
1 jkt 05/07/26 17:56:59
2
3 Modified: xml/htdocs/doc/en metadoc.xml
4 Added: xml/htdocs/doc/en gpm.xml
5 Log:
6 #99490, new guide: using a mouse within a console (gpm)
7
8 Revision Changes Path
9 1.82 +7 -2 xml/htdocs/doc/en/metadoc.xml
10
11 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.82&content-type=text/x-cvsweb-markup&cvsroot=gentoo
12 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.82&content-type=text/plain&cvsroot=gentoo
13 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml.diff?r1=1.81&r2=1.82&cvsroot=gentoo
14
15 Index: metadoc.xml
16 ===================================================================
17 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v
18 retrieving revision 1.81
19 retrieving revision 1.82
20 diff -u -r1.81 -r1.82
21 --- metadoc.xml 26 Jul 2005 10:53:26 -0000 1.81
22 +++ metadoc.xml 26 Jul 2005 17:56:59 -0000 1.82
23 @@ -1,9 +1,9 @@
24 <?xml version='1.0' encoding="UTF-8"?>
25 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.81 2005/07/26 10:53:26 jkt Exp $ -->
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.82 2005/07/26 17:56:59 jkt Exp $ -->
27 <!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd">
28
29 <metadoc lang="en">
30 -<version>1.18</version>
31 +<version>1.19</version>
32 <members>
33 <lead>swift</lead>
34 <lead>neysx</lead>
35 @@ -272,6 +272,7 @@
36 <file id="colinux-howto">/doc/en/colinux-howto.xml</file>
37 <file id="gentoo-sparc-obpreference">/doc/en/gentoo-sparc-obpreference.xml</file>
38 <file id="gnome-config">/doc/en/gnome-config.xml</file>
39 + <file id="gpm">/doc/en/gpm.xml</file>
40 <file id="macos-guide">/doc/en/macos-guide.xml</file>
41 <file id="gentoo-security">/doc/en/gentoo-security.xml</file>
42 <file id="home-router-howto">/doc/en/home-router-howto.xml</file>
43 @@ -711,6 +712,10 @@
44 <memberof>desktop_config</memberof>
45 <fileid>power-management-guide</fileid>
46 </doc>
47 + <doc id="gpm">
48 + <memberof>desktop_config</memberof>
49 + <fileid>gpm</fileid>
50 + </doc>
51 <doc id="kde-split-ebuilds">
52 <memberof>desktop_install</memberof>
53 <fileid>kde-split-ebuilds</fileid>
54
55
56
57 1.1 xml/htdocs/doc/en/gpm.xml
58
59 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/gpm.xml?rev=1.1&content-type=text/x-cvsweb-markup&cvsroot=gentoo
60 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/gpm.xml?rev=1.1&content-type=text/plain&cvsroot=gentoo
61
62 Index: gpm.xml
63 ===================================================================
64 <?xml version="1.0" encoding="UTF-8"?>
65 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
66 <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gpm.xml,v 1.1 2005/07/26 17:56:59 jkt Exp $ -->
67
68 <guide link="/doc/en/gpm.xml">
69 <title>Using a Mouse within the Console</title>
70
71 <author title="Author">
72 <mail link="jackdark@×××××.com">Joshua Saddler</mail>
73 </author>
74
75 <abstract>
76 This guide shows you how to set up and use gpm (the General
77 Purpose Mouse server) from within a command line interface.
78 This is especially useful for new Gentoo installations or
79 for systems that cannot or do not use an X server.
80 </abstract>
81
82 <!-- The content of this document is licensed under the CC-BY-SA license -->
83 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
84 <license/>
85
86 <version>1.0</version>
87 <date>2005-07-19</date>
88
89 <chapter>
90 <title>Getting gpm</title>
91 <section>
92 <body>
93
94 <p>
95 If you've just installed Gentoo, you almost certainly don't have your mouse
96 set up to work within a command line interface (CLI) yet. Or perhaps you
97 can't use or don't need an X server, yet you still need to use a mouse. The
98 solution is simple: <c>gpm</c>, the General Purpose Mouse server.
99 </p>
100
101 <p>
102 First, you will need to get gpm:
103 </p>
104
105 <pre caption="Obtaining gpm">
106 # <i>emerge gpm</i>
107 </pre>
108
109 <p>
110 You might have noticed a few messages during the compilation that warned
111 about configuring the server. You must do this before starting gpm.
112 </p>
113
114 </body>
115 </section>
116 </chapter>
117
118 <chapter>
119 <title>Configuring gpm</title>
120 <section>
121 <body>
122
123 <p>
124 Before you can use gpm, you will need to uncomment the lines
125 corresponding to the location and protocol of your mouse. You do this by
126 editing the gpm configuration file:
127 </p>
128
129 <pre caption="Setting up gpm">
130 # <i>nano /etc/conf.d/gpm</i>
131 </pre>
132
133 <p>
134 In my case, I have a USB mouse on <path>/dev/input/mouse0</path>. So, I
135 have uncommented <path>/dev/input/mice</path>, as this is the cumulative
136 device for all mice on the system, and the appropriate protocol.
137 Try using <path>/dev/input/mice</path> before <path>/dev/psaux</path>, as
138 the latter is deprecated and can be disabled in the latest 2.6 kernels. If
139 <path>/dev/input/mice</path> fails, then fall back to other devices. Here is
140 my example <path>/etc/conf.d/gpm</path>:
141 </p>
142
143 <pre caption="Example gpm config">
144 <comment># Please uncomment the type of mouse you have and the appropriate MOUSEDEV entry</comment>
145
146 #MOUSE=ps2
147 MOUSE=imps2
148 #MOUSEDEV=/dev/psaux
149 MOUSEDEV=/dev/input/mice
150 </pre>
151
152 <p>
153 If you have a wheelmouse, you will want to use the imps2 protocol, so
154 uncomment that line. If imps2 and ps2 both fail to work for you, please
155 refer to the gpm info page (<c>info gpm</c>) for other protocols to try.
156 Also, if you want to be able to click on hyperlinks in terminals to
157 navigate to a website, it is a good idea to follow the suggestion in the
158 <c>/etc/conf.d/gpm</c> file:
159 </p>
160
161 <pre caption="Other options">
162 <comment># Please uncomment this line if you want gpm to understand charsets</comment>
163 <comment># used in URLs and names with ~ or : in them, etc.</comment>
164 <comment># This is a good idea to turn on!</comment>
165
166 APPEND="-l \"a-zA-Z0-9_.:~/\300-\326\330-\366\370-\377\""
167 </pre>
168
169 <p>
170 The rest of the conf.d file contains other suggestions for your mouse server;
171 uncomment the various options according to your needs. See <c>man gpm</c>
172 for more information.
173 </p>
174
175 </body>
176 </section>
177 </chapter>
178
179 <chapter>
180 <title>Running gpm</title>
181 <section>
182 <body>
183
184 <p>
185 Now that your mouse server is installed and configured, it's time to start
186 using it:
187 </p>
188
189 <pre caption="The gpm init script">
190 # <i>/etc/init.d/gpm start</i>
191 </pre>
192
193 <p>
194 You should see a block cursor appear. Remember that only root can run the gpm
195 init script. However, to avoid having to <c>su</c> and run the script every
196 single time you begin a new session, why not set gpm to begin every time you
197 turn on your computer?
198 </p>
199
200 <pre caption="Adding gpm to the default runlevel">
201 # <i>rc-update add gpm default</i>
202 </pre>
203
204 <p>
205 Now, whenever you start your computer, you'll be greeted by the console cursor
206 by the time you get to the login prompt. The mouse server will continue to run
207 even if you're not logged in as root.
208 </p>
209
210 </body>
211 </section>
212 </chapter>
213
214 <chapter>
215 <title>Working with gpm</title>
216 <section>
217 <title>Copying and pasting</title>
218 <body>
219
220 <p>
221 Copying and pasting large blocks of text with a working mouse server is very
222 easy. Simply highlight the text with the left mouse button (it will stay
223 highlighted when you release the button), switch to a different terminal if you
224 wish, position the cursor, and press the middle mouse button to paste the text
225 where you placed the cursor. Note that you can copy and paste without ever
226 leaving the terminal you started. This makes posting the output of error
227 messages to the <uri link="http://forums.gentoo.org">Gentoo forums</uri>
228 extremely simple.
229 </p>
230
231 </body>
232 </section>
233 <section>
234 <title>Text-mode browsing and gpm</title>
235 <body>
236
237 <p>
238 If you have a message on one screen and a text-mode web browser on the other,
239 you can copy the error message by highlighting it, then change to the other
240 terminal, left-click the appropriate text entry box to select it, and then press
241 the middle mouse button. Voila! Your error message can now be posted to the
242 forums.
243 </p>
244
245 <p>
246 Though discussion of text-only browsers is somewhat beyond the scope of this
247 guide, inevitably users will need to find a compatible console browser. Though
248 <c>lynx</c> is most likely the oldest and well established browser, its
249 interface has poor mouse support and recognition. Instead, try using
250 <c>links</c>, the same browser which is also included in the Gentoo Installation
251 CDs. <c>links</c> has excellent mouse integration:
252 </p>
253
254 <pre caption="Obtaining links">
255 # <i>emerge links</i>
256 </pre>
257
258 <p>
259 This concludes the guide to using a mouse within the console. Happy mousing!
260 </p>
261
262 </body>
263
264
265
266 --
267 gentoo-doc-cvs@g.o mailing list