Merge lp:~littlergirl/kubuntu-docs/cli into lp:kubuntu-docs/precise
- cli
- Merge into precise
Proposed by
Little Girl
Status: | Merged |
---|---|
Merged at revision: | 266 |
Proposed branch: | lp:~littlergirl/kubuntu-docs/cli |
Merge into: | lp:kubuntu-docs/precise |
Diff against target: |
1699 lines (+405/-372) 3 files modified
docs/audio/C/audio.xml (+47/-45) docs/bugs/C/bugs.xml (+215/-169) docs/cli/C/cli.xml (+143/-158) |
To merge this branch: | bzr merge lp:~littlergirl/kubuntu-docs/cli |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Ubuntu Documentation Committers | Pending | ||
Review via email: mp+98789@code.launchpad.net |
Commit message
Description of the change
* Added some tags.
* Fixed emphasis tags.
* Fixed some grammar.
* Fixed some punctuation.
* Rewrapped some lines.
To post a comment you must log in.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'docs/audio/C/audio.xml' |
2 | --- docs/audio/C/audio.xml 2011-12-30 16:40:04 +0000 |
3 | +++ docs/audio/C/audio.xml 2012-03-22 06:58:18 +0000 |
4 | @@ -22,20 +22,20 @@ |
5 | <title>Playing CDs</title> |
6 | <para> |
7 | <application>Amarok</application> is the default application for playing audio |
8 | -<acronym>CDs</acronym> in &kubuntu;. When a <acronym>CD</acronym> is inserted, |
9 | +<acronym>CD</acronym>s in &kubuntu;. When a <acronym>CD</acronym> is inserted, |
10 | &kubuntu; will recognize it and display default options. To hear the content |
11 | with <application>Amarok</application>, select <guilabel>Play Audio CD with |
12 | Amarok</guilabel> and then press the <guibutton>OK</guibutton> button. |
13 | &kubuntu; can be configured to remember this choice every time |
14 | a <acronym>CD</acronym> is inserted by selecting <guilabel>Always do |
15 | this for this type of media</guilabel>, and pressing <guibutton>OK</guibutton>. |
16 | -<application>Amarok</application> also offers other useful features. If connected to |
17 | -the Internet, <application>Amarok</application> will retrieve |
18 | +<application>Amarok</application> also offers other useful features. If |
19 | +connected to the Internet, <application>Amarok</application> will retrieve |
20 | <acronym>CD</acronym> artist, title, and track data from <ulink |
21 | url="http://freedb.org">freedb.org</ulink>. It will also download the lyrics |
22 | -for the current selection if they are available by choosing the |
23 | -<guilabel>Lyrics</guilabel> tab. Other Artist information can be found on <ulink |
24 | -url="http://www.wikipedia.org">Wikipedia</ulink> by selecting the |
25 | +for the current selection — if they are available — by choosing the |
26 | +<guilabel>Lyrics</guilabel> tab. Other artist information can be found on |
27 | +<ulink url="http://www.wikipedia.org">Wikipedia</ulink> by selecting the |
28 | <guilabel>Artist</guilabel> tab. |
29 | </para> |
30 | </sect1> |
31 | @@ -44,19 +44,21 @@ |
32 | <title>Editing Audio </title> |
33 | |
34 | <para> |
35 | -For editing audio files, &kubuntu; provides <application>Sound Editor (Audacity)</application>, |
36 | -a full-featured, free and open source software application. To use |
37 | -<application>Sound Editor (Audacity)</application>: |
38 | +For editing audio files, &kubuntu; provides <application>Sound Editor |
39 | +(Audacity)</application>, a full-featured, free, and open source software |
40 | +application. To use <application>Sound Editor (Audacity)</application>: |
41 | </para> |
42 | <procedure> |
43 | <step> |
44 | <para> |
45 | -Install <application>Sound Editor (Audacity)</application> from the package manager (Muon) |
46 | +Install <application>Sound Editor (Audacity)</application> from the package |
47 | +manager (Muon). |
48 | </para> |
49 | </step> |
50 | <step> |
51 | <para> |
52 | -Run <application>Sound Editor (Audacity)</application> by going to &menuaudacity;. |
53 | +Run <application>Sound Editor (Audacity)</application> by going to |
54 | +&menuaudacity;. |
55 | </para> |
56 | </step> |
57 | <step> |
58 | @@ -64,8 +66,7 @@ |
59 | Detailed instructions (including tutorials and weblinks) on using |
60 | <application>Sound Editor (Audacity)</application> can be found by going to |
61 | <menuchoice> |
62 | -<guimenu>Help</guimenu> |
63 | -<guisubmenu>Contents</guisubmenu> |
64 | +<guimenu>Help</guimenu> <guisubmenu>Contents</guisubmenu> |
65 | </menuchoice> from within <application>Sound Editor (Audacity)</application>. |
66 | </para> |
67 | </step> |
68 | @@ -78,7 +79,7 @@ |
69 | <para> |
70 | In addition to being the default music player in &kubuntu;, |
71 | <application>Amarok</application> is also helpful for managing music |
72 | -collections. Start <application>Amarok</application> by going to &menuamarok;. |
73 | +collections. Start <application>Amarok</application> by going to &menuamarok;. |
74 | </para> |
75 | <para> |
76 | Another useful <application>Amarok</application> feature is the built-in ID3 |
77 | @@ -93,10 +94,11 @@ |
78 | |
79 | <para> |
80 | Another exciting <application>Amarok</application> feature is the ability to |
81 | -play music directly from an iPod or other portable device. <application>Amarok</application> can also be |
82 | -used to transfer music files to and from an iPod. Please refer to the <ulink |
83 | -type="help" url="help:/amarok">Amarok Handbook</ulink> for more information on |
84 | -transferring and managing iPod media files. |
85 | +play music directly from an iPod or other portable device. |
86 | +<application>Amarok</application> can also be used to transfer music files to |
87 | +and from an iPod. Please refer to the <ulink type="help" |
88 | +url="help:/amarok">Amarok Handbook</ulink> for more information on transferring |
89 | +and managing iPod media files. |
90 | </para> |
91 | </sect1> |
92 | |
93 | @@ -105,30 +107,29 @@ |
94 | <procedure> |
95 | <step> |
96 | <para> |
97 | -When a blank <acronym>CD</acronym> is inserted, &kubuntu; will |
98 | -recognize it, mount it, and then ask what to do with the <acronym>CD</acronym>. |
99 | -Choose <guilabel>Create an audio CD with K3B</guilabel> and press |
100 | -<guibutton>OK</guibutton>. This will open |
101 | -<application>K3b</application>, the <acronym>CD</acronym> and |
102 | -<acronym>DVD</acronym> Kreator, and provide various options. |
103 | +When a blank <acronym>CD</acronym> is inserted, &kubuntu; will recognize it, |
104 | +mount it, and then ask what to do with the <acronym>CD</acronym>. Choose |
105 | +<guilabel>Create an audio CD with K3B</guilabel> and press |
106 | +<guibutton>OK</guibutton>. This will open the <application>K3b</application> |
107 | +<acronym>CD</acronym> and <acronym>DVD</acronym> creator, and provide various |
108 | +options. |
109 | </para> |
110 | </step> |
111 | <step> |
112 | <para> |
113 | -To start <application>K3b</application> manually, go to <guilabel>Kickoff Application |
114 | -> Applications > Multimedia > </guilabel><application>Disk Burning (K3b)</application>. |
115 | +To start <application>K3b</application> manually, go to &menuk3b;. |
116 | </para> |
117 | </step> |
118 | <step> |
119 | <para> |
120 | Select <guilabel>New Audio CD Project</guilabel> in the <guilabel>New |
121 | -Project</guilabel> dropdown menu. |
122 | +Project</guilabel> drop-down menu. |
123 | </para> |
124 | </step> |
125 | <step> |
126 | <para> |
127 | Inside <application>K3b</application>, browse and select the tracks to be |
128 | -ripped. Then drag and drop the tracks in the white area at the bottom of the |
129 | +ripped. Then drag and drop the tracks into the white area at the bottom of the |
130 | <application>K3b</application> window. |
131 | <mediaobject> |
132 | <imageobject> |
133 | @@ -154,9 +155,10 @@ |
134 | <itemizedlist> |
135 | <listitem> |
136 | <para> |
137 | -<guilabel>Writing</guilabel> - provides choices related to burning an image from |
138 | -the files selected in the previous step. |
139 | -<note><title>No MP3 Support by Default</title> |
140 | +<guilabel>Writing</guilabel> - provides choices related to burning an image |
141 | +from the files selected in the previous step. |
142 | +<note> |
143 | +<title>No MP3 Support by Default</title> |
144 | <para> |
145 | <acronym>MP3</acronym> is a protocol restricted by patents. In order to use it |
146 | with <application>K3b</application>, please refer to the information at the end |
147 | @@ -194,36 +196,36 @@ |
148 | </step> |
149 | </procedure> |
150 | <para> |
151 | -<application>K3b</application> can extract audio files to the following formats: |
152 | +<application>K3b</application> can extract audio files to the following |
153 | +formats: |
154 | <itemizedlist> |
155 | <listitem> |
156 | <para> |
157 | -<emphasis role="strong">Ogg Vorbis</emphasis> - Ogg |
158 | -Vorbis is a patent-free lossy audio compression format which usually produces |
159 | -higher quality and greater compression than MP3. See the <ulink |
160 | -url="http://www.vorbis.com/faq/">Vorbis website</ulink> for more information. |
161 | +<emphasis role="strong">Ogg Vorbis</emphasis> - Ogg Vorbis is a patent-free |
162 | +lossy audio compression format which usually produces higher quality and |
163 | +greater compression than MP3. See the <ulink url="http://www.vorbis.com/faq/"> |
164 | +Vorbis website</ulink> for more information. |
165 | </para> |
166 | </listitem> |
167 | <listitem> |
168 | <para><emphasis role="strong">FLAC</emphasis> - The Free Lossless Audio |
169 | -Codec, <acronym>FLAC</acronym>, can compress audio files up to 50% without removing |
170 | -any information from the audio stream. For more information on this format, see |
171 | -the <ulink url="http://flac.sourceforge.net/">FLAC homepage</ulink> on |
172 | -sourceforge.net. |
173 | +Codec, <acronym>FLAC</acronym>, can compress audio files up to 50% without |
174 | +removing any information from the audio stream. For more information on this |
175 | +format, see the <ulink url="http://flac.sourceforge.net/">FLAC |
176 | +homepage</ulink> on <trademark>Sourceforge</trademark>. |
177 | </para> |
178 | </listitem> |
179 | <listitem> |
180 | -<para><emphasis role="strong">WAV</emphasis> - Wav is an |
181 | -uncompressed audio format that can be compressed into OGG Vorbis or a codec of |
182 | -your choice. It is often edited in applications such as Audacity before being |
183 | -compressed. |
184 | +<para><emphasis role="strong">WAV</emphasis> - Wav is an uncompressed audio |
185 | +format that can be compressed into OGG Vorbis or a codec of your choice. It is |
186 | +often edited in applications such as Audacity before being compressed. |
187 | </para> |
188 | </listitem> |
189 | </itemizedlist> |
190 | </para> |
191 | <para> |
192 | CD audio files can be extracted to the proprietary, non-free |
193 | -<emphasis role="strong">MP3</emphasis> lossy format by using the |
194 | +<emphasis role="strong">MP3</emphasis> lossy format by using the |
195 | <application>lame</application> encoder. Please refer to the <ulink type="help" |
196 | url="help:/kubuntu/add-applications/">Adding Applications</ulink> documentation |
197 | for help with installing applications such as <application>lame</application>. |
198 | |
199 | === modified file 'docs/bugs/C/bugs.xml' |
200 | --- docs/bugs/C/bugs.xml 2011-09-15 05:13:39 +0000 |
201 | +++ docs/bugs/C/bugs.xml 2012-03-22 06:58:18 +0000 |
202 | @@ -28,8 +28,8 @@ |
203 | <varlistentry><term>Crash</term> |
204 | <listitem> |
205 | <para> |
206 | -An application or system crash or failure. Most of the time, a crash dialog will |
207 | -be presented that can be turned into a bug report. |
208 | +An application or system crash or failure. Most of the time a crash dialog will |
209 | +be presented. This can be turned into a bug report. |
210 | </para> |
211 | </listitem> |
212 | </varlistentry> |
213 | @@ -59,19 +59,25 @@ |
214 | <title>KDE's Bug Tracking System</title> |
215 | <para><ulink url="https://bugs.kde.org/"/></para> |
216 | <para> |
217 | -KDE uses Bugzilla, a "Defect Tracking System". Bugzilla is one of the |
218 | -most popular tools used in the open source development community. |
219 | +<trademark>KDE</trademark> uses <trademark>Bugzilla</trademark>, a |
220 | +<quote>Defect Tracking System</quote>. <trademark>Bugzilla</trademark> is one |
221 | +of the most popular tools used in the open source development community. |
222 | </para> |
223 | <note><title>Register first</title> |
224 | <para> |
225 | -To report a bug, one must register for an account on KDE's Bugzilla |
226 | -at <ulink url="https://bugs.kde.org/createaccount.cgi"/>. A valid email address |
227 | -is required for registration. |
228 | +To report a bug, one must register for an account on |
229 | +<trademark>KDE</trademark>'s <trademark>Bugzilla</trademark> at <ulink |
230 | +url="https://bugs.kde.org/createaccount.cgi"/>. A valid email address is |
231 | +required for registration. |
232 | </para> |
233 | </note> |
234 | <note><title>Only for KDE bugs</title> |
235 | <para> |
236 | -Bugzilla is only for KDE bugs. If the application is not part of KDE, for instance Firefox, LibreOffice, or VLC, then the report should be filed in Launchpad instead. Please see the next section, which covers filing reports concerning Launchpad. |
237 | +<trademark>Bugzilla</trademark> is only for <trademark>KDE</trademark> bugs. If |
238 | +the application is not part of <trademark>KDE</trademark> — Firefox, |
239 | +LibreOffice, or VLC, for instance — then the report should be filed in |
240 | +Launchpad instead. Please see the next section, which covers filing reports |
241 | +concerning Launchpad. |
242 | </para> |
243 | </note> |
244 | </sect2> |
245 | @@ -79,22 +85,24 @@ |
246 | <title>Launchpad</title> |
247 | <para><ulink url="https://launchpad.net/"/></para> |
248 | <para> |
249 | -Launchpad is an open source suite of tools that help people and teams to work |
250 | -together on software projects. Launchpad is used by the Ubuntu and &kubuntu; |
251 | -Projects, as well as various other open source projects. |
252 | +<trademark>Launchpad</trademark> is an open source suite of tools that help |
253 | +people and teams to work together on software projects. Launchpad is used by |
254 | +the &ubuntu; and &kubuntu; projects, as well as various other open source |
255 | +projects. |
256 | </para> |
257 | <note><title>Register first</title> |
258 | <para> |
259 | -To report a bug, one must register for a Launchpad account at |
260 | -<ulink url="https://launchpad.net/+login"/>. A valid email address is required |
261 | -for registration. |
262 | +To report a bug, one must register for a <trademark>Launchpad</trademark> |
263 | +account at <ulink url="https://launchpad.net/+login"/>. A valid email address |
264 | +is required for registration. |
265 | </para> |
266 | </note> |
267 | <note><title>For any bug in &kubuntu;</title> |
268 | <para> |
269 | -Launchpad can be used to file a bug report for any application available in the |
270 | -Ubuntu or &kubuntu; repositories. For KDE applications, the |
271 | -KDE Bug Tracking system (above) is preferred. |
272 | +<trademark>Launchpad</trademark> can be used to file a bug report for any |
273 | +application available in the &ubuntu; or &kubuntu; repositories. For |
274 | +<trademark>KDE</trademark> applications, the <trademark>KDE Bug |
275 | +Tracking</trademark> system (above) is preferred. |
276 | </para> |
277 | </note> |
278 | </sect2> |
279 | @@ -104,18 +112,19 @@ |
280 | <title>Filing a Crash Report</title> |
281 | <para> |
282 | When an application crashes in &kubuntu;, the appropriate crash dialog will |
283 | -appear. It is usually easy to file a bug report from the dialog. With a KDE |
284 | -application, the KDE crash dialog will appear along with instructions |
285 | -for reporting the bug. Otherwise, the Ubuntu crash dialog will appear with |
286 | -instructions for filing a bug on Launchpad. |
287 | +appear. It is usually easy to file a bug report from the dialog. With a |
288 | +<trademark>KDE</trademark> application, the <trademark>KDE</trademark> crash |
289 | +dialog will appear along with instructions for reporting the bug. Otherwise, |
290 | +the &ubuntu; crash dialog will appear with instructions for filing a bug on |
291 | +<trademark>Launchpad</trademark>. |
292 | </para> |
293 | <sect2 id="filing-crash-kde"> |
294 | <title>KDE</title> |
295 | <para> |
296 | -When an application crashes in KDE, a crash dialog will be presented that is |
297 | -similar to the following images. The first image shows the |
298 | -<guilabel>General</guilabel> tab which provides an overview of the crash. The |
299 | -second image shows the <guilabel>Developer Information</guilabel> tab which |
300 | +When an application crashes in <trademark>KDE</trademark>, a crash dialog will |
301 | +be presented that is similar to the following images. The first image shows the |
302 | +<guilabel>General</guilabel> tab, which provides an overview of the crash. The |
303 | +second image shows the <guilabel>Developer Information</guilabel> tab, which |
304 | provides trace information that is useful to developers. |
305 | </para> |
306 | <para> |
307 | @@ -139,10 +148,10 @@ |
308 | </example> |
309 | </para> |
310 | <para> |
311 | -If the trace information is deemed valuable, filing a bug report is |
312 | -easy with the crash dialog wizard. If the trace is not deemed valuable, then it |
313 | -is not possible to file a bug report with the wizard. The bug report can still |
314 | -be filed manually at <ulink url="https://bugs.kde.org/"/>. |
315 | +If the trace information is deemed valuable, filing a bug report is easy with |
316 | +the crash dialog wizard. If the trace is not deemed valuable, then it is not |
317 | +possible to file a bug report with the wizard. The bug report can still be |
318 | +filed manually at <ulink url="https://bugs.kde.org/"/>. |
319 | </para> |
320 | <para> |
321 | To complete the bug reporting process, follow the procedure below. |
322 | @@ -151,14 +160,15 @@ |
323 | <step> |
324 | <para> |
325 | <mousebutton>Click</mousebutton> the <guibutton>Report Bug</guibutton> button. |
326 | -The following dialog will appear. |
327 | +The following dialog will appear: |
328 | </para> |
329 | <para> |
330 | <example> |
331 | <title>Welcome to the Reporting Assistant</title> |
332 | <mediaobject> |
333 | <imageobject> |
334 | -<imagedata fileref="help:/images/C/crash_report_assistant_welcome.png" format="PNG"/> |
335 | +<imagedata |
336 | +fileref="help:/images/C/crash_report_assistant_welcome.png" format="PNG"/> |
337 | </imageobject> |
338 | </mediaobject> |
339 | </example> |
340 | @@ -167,14 +177,15 @@ |
341 | <step> |
342 | <para> |
343 | <mousebutton>Click</mousebutton> the <guibutton>Next</guibutton> button. The |
344 | -following dialog will appear. |
345 | +following dialog will appear: |
346 | </para> |
347 | <para> |
348 | <example> |
349 | <title>What do you know about the crash?</title> |
350 | <mediaobject> |
351 | <imageobject> |
352 | -<imagedata fileref="help:/images/C/crash_report_assistant_about_crash.png" format="PNG"/> |
353 | +<imagedata |
354 | +fileref="help:/images/C/crash_report_assistant_about_crash.png" format="PNG"/> |
355 | </imageobject> |
356 | </mediaobject> |
357 | </example> |
358 | @@ -183,15 +194,17 @@ |
359 | <step> |
360 | <para> |
361 | Select the applicable options. The drop-down box under the question, |
362 | -"<guilabel>Does the application crash again if you repeat the |
363 | -same situation?</guilabel>" has several options. |
364 | +<quote><guilabel>Does the application crash again if you repeat the |
365 | +same situation?</guilabel></quote> has several options. |
366 | </para> |
367 | <para> |
368 | <example> |
369 | <title>Does the application crash again if you repeat the same situation?</title> |
370 | <mediaobject> |
371 | <imageobject> |
372 | -<imagedata fileref="help:/images/C/crash_report_assistant_about_crash_dropdown.png" format="PNG"/> |
373 | +<imagedata |
374 | +fileref="help:/images/C/crash_report_assistant_about_crash_dropdown.png" |
375 | +format="PNG"/> |
376 | </imageobject> |
377 | </mediaobject> |
378 | </example> |
379 | @@ -205,18 +218,21 @@ |
380 | </step> |
381 | <step> |
382 | <para> |
383 | -Depending on the information available in the crash report, either of two |
384 | +Depending on the information available in the crash report, either of two |
385 | dialogs will appear. One is a dialog that indicates that there is not enough |
386 | information to file a good report. The other is a dialog indicating that the |
387 | -information is useful, and that it would be helpful to continue with filing the |
388 | +information is useful and that it would be helpful to continue with filing the |
389 | report. |
390 | </para> |
391 | <para> |
392 | <example> |
393 | -<title>Not enough information for developers to continue the reporting process</title> |
394 | +<title>Not enough information for developers to continue the reporting |
395 | +process</title> |
396 | <mediaobject> |
397 | <imageobject> |
398 | -<imagedata fileref="help:/images/C/crash_report_assistant_not_enough_info.png" format="PNG"/> |
399 | +<imagedata |
400 | +fileref="help:/images/C/crash_report_assistant_not_enough_info.png" |
401 | +format="PNG"/> |
402 | </imageobject> |
403 | </mediaobject> |
404 | </example> |
405 | @@ -226,7 +242,9 @@ |
406 | <title>This crash information is useful</title> |
407 | <mediaobject> |
408 | <imageobject> |
409 | -<imagedata fileref="help:/images/C/crash_report_assistant_useful_information.png" format="PNG"/> |
410 | +<imagedata |
411 | +fileref="help:/images/C/crash_report_assistant_useful_information.png" |
412 | +format="PNG"/> |
413 | </imageobject> |
414 | </mediaobject> |
415 | </example> |
416 | @@ -235,7 +253,7 @@ |
417 | <para> |
418 | It may be necessary to install the proper debug packages in order to get a good |
419 | trace. Such packages include <filename>kdebase-dbg</filename>, |
420 | -<filename>kdebase-workspace-dbg</filename>, |
421 | +<filename>kdebase-workspace-dbg</filename>, and |
422 | <filename>kdebase-runtime-dbg</filename>. |
423 | </para> |
424 | </note> |
425 | @@ -243,36 +261,42 @@ |
426 | <step> |
427 | <para> |
428 | If enough information was provided to continue filing a bug report using |
429 | -the assistant, a dialog will appear to allow logging in to KDE's Bugzilla. |
430 | +the assistant, a dialog will appear to allow logging in to |
431 | +<trademark>KDE</trademark>'s <trademark>Bugzilla</trademark>. |
432 | </para> |
433 | <para> |
434 | <example> |
435 | <title>KDE Bug Tracking System Login</title> |
436 | <mediaobject> |
437 | <imageobject> |
438 | -<imagedata fileref="help:/images/C/crash_report_assistant_bugtracker_login.png" format="PNG"/> |
439 | +<imagedata |
440 | +fileref="help:/images/C/crash_report_assistant_bugtracker_login.png" |
441 | +format="PNG"/> |
442 | </imageobject> |
443 | </mediaobject> |
444 | </example> |
445 | </para> |
446 | <note><title>Use e-mail address as username</title> |
447 | <para> |
448 | -Use the e-mail address that was used to register with KDE's Bugzilla. |
449 | +Use the email address that was used to register with |
450 | +<trademark>KDE</trademark>'s <trademark>Bugzilla</trademark>. |
451 | </para> |
452 | </note> |
453 | </step> |
454 | <step> |
455 | <para> |
456 | -After logging in with username (e-mail address) and password, |
457 | +After logging in with your username (email address) and password, |
458 | <mousebutton>click</mousebutton> the <guibutton>Login</guibutton> button. The |
459 | -assistant will check for duplicates and display the following dialog. |
460 | +assistant will check for duplicates and display the following dialog: |
461 | </para> |
462 | <para> |
463 | <example> |
464 | <title>Bug Report Possible Duplicates List</title> |
465 | <mediaobject> |
466 | <imageobject> |
467 | -<imagedata fileref="help:/images/C/crash_report_assistant_possible_duplicates.png" format="PNG"/> |
468 | +<imagedata |
469 | +fileref="help:/images/C/crash_report_assistant_possible_duplicates.png" |
470 | +format="PNG"/> |
471 | </imageobject> |
472 | </mediaobject> |
473 | </example> |
474 | @@ -283,14 +307,17 @@ |
475 | If there is a possible duplicate report, <mousebutton>click</mousebutton> the |
476 | report in the list and then <mousebutton>click</mousebutton> the <guibutton>Open |
477 | selected report</guibutton> button. Either of the following dialogs will be |
478 | -presented. |
479 | +presented: |
480 | </para> |
481 | <para> |
482 | <example> |
483 | -<title>The report you selected is already marked as a duplicate of bug...</title> |
484 | +<title>The report you selected is already marked as a duplicate of |
485 | +bug...</title> |
486 | <mediaobject> |
487 | <imageobject> |
488 | -<imagedata fileref="help:/images/C/crash_report_assistant_nested_duplicate_detected.png" format="PNG"/> |
489 | +<imagedata |
490 | +fileref="help:/images/C/crash_report_assistant_nested_duplicate_detected.png" |
491 | +format="PNG"/> |
492 | </imageobject> |
493 | </mediaobject> |
494 | </example> |
495 | @@ -300,7 +327,9 @@ |
496 | <title>Showing the duplicate bug report you selected</title> |
497 | <mediaobject> |
498 | <imageobject> |
499 | -<imagedata fileref="help:/images/C/crash_report_assistant_duplicate_report.png" format="PNG"/> |
500 | +<imagedata |
501 | +fileref="help:/images/C/crash_report_assistant_duplicate_report.png" |
502 | +format="PNG"/> |
503 | </imageobject> |
504 | </mediaobject> |
505 | </example> |
506 | @@ -313,23 +342,26 @@ |
507 | bug report and inform the developers that it may be a duplicate. This is |
508 | recommended, except in cases with experienced users where it is clearly not a |
509 | duplicate. <mousebutton>Clicking</mousebutton> the <guibutton>Attach to this |
510 | -report (Advanced)</guibutton> will attach the crash information to the report. |
511 | +report (Advanced)</guibutton> button will attach the crash information to the |
512 | +report. |
513 | </para> |
514 | <para> |
515 | If the bug is not a duplicate, simply <mousebutton>click</mousebutton> |
516 | -the <guibutton>Next</guibutton> in the dialog showing the possible duplicates. |
517 | -A dialog will appear with <guibutton>Let me check more reports</guibutton>. To |
518 | -prevent checking for more reports and continue to file the report, |
519 | -<mousebutton>click</mousebutton> the <guibutton>There |
520 | -are no real duplicates</guibutton> button. A dialog will appear to enter |
521 | -additional information concerning the report. |
522 | +the <guibutton>Next</guibutton> button in the dialog showing the possible |
523 | +duplicates. A dialog will appear with <guibutton>Let me check more |
524 | +reports</guibutton>. To prevent checking for more reports and continue filing |
525 | +the report, <mousebutton>click</mousebutton> the <guibutton>There |
526 | +are no real duplicates</guibutton> button. A dialog will appear asking you to |
527 | +enter additional information concerning the report. |
528 | </para> |
529 | <para> |
530 | <example> |
531 | <title>Details of the Bug Report</title> |
532 | <mediaobject> |
533 | <imageobject> |
534 | -<imagedata fileref="help:/images/C/crash_report_assistant_report_details.png" format="PNG"/> |
535 | +<imagedata |
536 | +fileref="help:/images/C/crash_report_assistant_report_details.png" |
537 | +format="PNG"/> |
538 | </imageobject> |
539 | </mediaobject> |
540 | </example> |
541 | @@ -337,16 +369,18 @@ |
542 | </step> |
543 | <step> |
544 | <para> |
545 | -Once the details of the bug report are complete, |
546 | -<mousebutton>click</mousebutton> the <guibutton>Next</guibutton> button. The |
547 | -following dialog will be presented. |
548 | +Once the details of the bug report are complete, |
549 | +<mousebutton>click</mousebutton> the <guibutton>Next</guibutton> button. The |
550 | +following dialog will be presented: |
551 | </para> |
552 | <para> |
553 | <example> |
554 | <title>Preview Report</title> |
555 | <mediaobject> |
556 | <imageobject> |
557 | -<imagedata fileref="help:/images/C/crash_report_assistant_report_details_preview.png" format="PNG"/> |
558 | +<imagedata |
559 | +fileref="help:/images/C/crash_report_assistant_report_details_preview.png" |
560 | +format="PNG"/> |
561 | </imageobject> |
562 | </mediaobject> |
563 | </example> |
564 | @@ -355,14 +389,16 @@ |
565 | <step> |
566 | <para> |
567 | If the information looks correct, <mousebutton>click</mousebutton> the |
568 | -<guibutton>Next</guibutton> button. The following dialog will be presented. |
569 | +<guibutton>Next</guibutton> button. The following dialog will be presented: |
570 | </para> |
571 | <para> |
572 | <example> |
573 | <title>Send Crash Report</title> |
574 | <mediaobject> |
575 | <imageobject> |
576 | -<imagedata fileref="help:/images/C/crash_report_assistant_report_filed.png" format="PNG"/> |
577 | +<imagedata |
578 | +fileref="help:/images/C/crash_report_assistant_report_filed.png" |
579 | +format="PNG"/> |
580 | </imageobject> |
581 | </mediaobject> |
582 | </example> |
583 | @@ -370,18 +406,19 @@ |
584 | </step> |
585 | </procedure> |
586 | <para> |
587 | -<emphasis role="bold">Congratulations on a successful bug report!</emphasis> |
588 | -Identifying and reporting bugs are essential to improving &kubuntu; and KDE. |
589 | -Some emails may be sent to the registered address to update progress or to |
590 | -allow developers to get additional information about the bug. |
591 | +<emphasis>Congratulations on a successful bug report!</emphasis> Identifying |
592 | +and reporting bugs are essential to improving &kubuntu; and |
593 | +<trademark>KDE</trademark>. Some emails may be sent to the registered address |
594 | +to update progress or to allow developers to get additional information about |
595 | +the bug. |
596 | </para> |
597 | </sect2> |
598 | <sect2 id="filing-crash-lp"> |
599 | <title>Launchpad</title> |
600 | <para> |
601 | -When an application that is not KDE crashes in &kubuntu;, a pop-up notification |
602 | -will appear from <application>Apport</application> that is similar to the |
603 | -following image. |
604 | +When an application that is not <trademark>KDE</trademark> crashes in |
605 | +&kubuntu;, a pop-up notification will appear from |
606 | +<application>Apport</application> that is similar to the following image: |
607 | </para> |
608 | <para> |
609 | <example><title>Apport Crash Pop-pup Notification</title> |
610 | @@ -394,11 +431,11 @@ |
611 | </para> |
612 | <note><title>Crash information may be different</title> |
613 | <para> |
614 | -The following screen shots were created by crashing the application |
615 | -<application>VLC</application> deliberately. Crash dialogs associated with other |
616 | -applications will be different. In an actual bug situation, the application |
617 | -name, <application>VLC</application>, will be replaced by the name of the |
618 | -application that actually crashed. |
619 | +The screen shots below were created by crashing the application |
620 | +<application>VLC</application> deliberately. Crash dialogs associated with |
621 | +other applications will be different. In an actual bug situation, the |
622 | +application name, <application>VLC</application>, will be replaced by the name |
623 | +of the application that actually crashed. |
624 | </para> |
625 | </note> |
626 | <para> |
627 | @@ -409,7 +446,7 @@ |
628 | <para> |
629 | <mousebutton>Click</mousebutton> the <guibutton>Details</guibutton> buttons on |
630 | the <application>System Notification Helper</application>. The following dialog |
631 | -will be presented. |
632 | +will be presented: |
633 | </para> |
634 | <para> |
635 | <example> |
636 | @@ -441,11 +478,11 @@ |
637 | </step> |
638 | <step> |
639 | <para> |
640 | -After all of the information concerning the crash is collected, a dialog will |
641 | -be presented that displays the details of the report, and the report is sent to |
642 | -the developers. <mousebutton>Click</mousebutton> the |
643 | +After all information concerning the crash is collected, a dialog will be |
644 | +presented that displays the details of the report, and the report is sent to |
645 | +the developers. <mousebutton>Click</mousebutton> the |
646 | <guibutton>Details...</guibutton> button to view details of the report. The |
647 | -following dialog will be presented. |
648 | +following dialog will be presented: |
649 | </para> |
650 | <para> |
651 | <example><title>Send problem report to the developers? (Details)</title> |
652 | @@ -460,8 +497,8 @@ |
653 | <step> |
654 | <para> |
655 | <mousebutton>Click</mousebutton> the <guibutton>Send</guibutton> button to send |
656 | -the report to the developers. In this case, it will send the report to |
657 | -Launchpad. The following progress dialog will be presented. |
658 | +the report to the developers. In this case, it will send the report to |
659 | +<trademark>Launchpad</trademark>. The following progress dialog will be presented: |
660 | </para> |
661 | <para> |
662 | <example><title>Uploading problem information</title> |
663 | @@ -476,15 +513,16 @@ |
664 | <step> |
665 | <para> |
666 | After the progress dialog completes, the default web browser will open to |
667 | -Launchpad presenting either the login page or the beginning of the online |
668 | -version of the bug reporting process. After logging in (if necessary) the |
669 | -following page will be presented. |
670 | +<trademark>Launchpad</trademark>, presenting either the log-in page or the |
671 | +beginning of the online version of the bug reporting process. After logging in |
672 | +(if necessary), the following page will be presented: |
673 | </para> |
674 | <para> |
675 | <example><title>Please wait while bug data is processed...</title> |
676 | <mediaobject> |
677 | <imageobject> |
678 | -<imagedata fileref="help:/images/C/apport-browser-processing.png" format="PNG"/> |
679 | +<imagedata fileref="help:/images/C/apport-browser-processing.png" |
680 | +format="PNG"/> |
681 | </imageobject> |
682 | </mediaobject> |
683 | </example> |
684 | @@ -492,8 +530,8 @@ |
685 | </step> |
686 | <step> |
687 | <para> |
688 | -When Launchpad is finished processing the bug data, the following page will be |
689 | -presented. |
690 | +When <trademark>Launchpad</trademark> is finished processing the bug data, the |
691 | +following page will be presented: |
692 | </para> |
693 | <para> |
694 | <example><title>Extra debug information will be added...</title> |
695 | @@ -508,7 +546,7 @@ |
696 | <step> |
697 | <para> |
698 | <mousebutton>Click</mousebutton> the <guibutton>Next</guibutton> button. The |
699 | -following page will be presented. |
700 | +following page will be presented: |
701 | </para> |
702 | <para> |
703 | <example><title>Further information</title> |
704 | @@ -522,10 +560,10 @@ |
705 | </step> |
706 | <step> |
707 | <para> |
708 | -Any extra information can be filled in about the bug report such as what was |
709 | -being done when it crashed or the online file locations that may have caused the |
710 | -crash. The following is a brief description filed with the report in |
711 | -this procedure. |
712 | +Any extra information about the bug report can be filled in to describe, for |
713 | +example, what was being done when the application crashed or the online file |
714 | +locations that may have caused the crash. The following is a brief description |
715 | +filed with the report in this procedure: |
716 | </para> |
717 | <para> |
718 | <example><title>Further information (Completed)</title> |
719 | @@ -540,7 +578,7 @@ |
720 | <step> |
721 | <para> |
722 | <mousebutton>Click</mousebutton> the <guibutton>Submit Bug Report</guibutton> |
723 | -button on the bottom of the page. The following page will be presented. |
724 | +button on the bottom of the page. The following page will be presented: |
725 | </para> |
726 | <para> |
727 | <example><title>Thank you for your bug report</title> |
728 | @@ -554,10 +592,10 @@ |
729 | </step> |
730 | </procedure> |
731 | <para> |
732 | -<emphasis role="bold">Congratulations on making a successful crash |
733 | -report!</emphasis>Identifying and reporting bugs are essential to improving |
734 | -&kubuntu;. Some emails may be sent to the registered address to update progress |
735 | -or to allow developers to get additional information about the bug. |
736 | +<emphasis>Congratulations on making a successful crash report!</emphasis> |
737 | +Identifying and reporting bugs are essential to improving &kubuntu;. Some |
738 | +emails may be sent to the registered address to update progress or to allow |
739 | +developers to get additional information about the bug. |
740 | </para> |
741 | </sect2> |
742 | </sect1> |
743 | @@ -565,32 +603,33 @@ |
744 | <sect1 id="filing-non-crash"> |
745 | <title>Filing a Non-Crash or Regression Report</title> |
746 | <para> |
747 | -If an application has regressed in functionality, a bug report should be |
748 | -filed on that application. A regress occurs when a function worked in a previous |
749 | -release but in the latest release, it is not working. In most cases, this type |
750 | -of report will be filed by those who have more experience and may be testing |
751 | -beta quality software. However there are situations where a user needs to report |
752 | -an issue with an application that isn't working right, but isn't crashing. The |
753 | -following procedures will help. |
754 | +If an application has regressed in functionality, a bug report should be filed |
755 | +on that application. A regression occurs when a function worked in a previous |
756 | +release, but is not working in the latest release. In most cases, this type of |
757 | +report will be filed by those who have previous experience and may be testing |
758 | +beta quality software. There are, however, situations where a user needs to |
759 | +report an issue with an application that isn't working right, but isn't |
760 | +crashing. The following procedures will help: |
761 | </para> |
762 | <sect2 id="filing-non-crash-kde"> |
763 | <title>KDE</title> |
764 | <para> |
765 | -Filing non-crash related bug reports for KDE applications are done with a web |
766 | -browser using <ulink url="https://bugs.kde.org/"/>. |
767 | +Filing non-crash related bug reports for <trademark>KDE</trademark> |
768 | +applications is done with a web browser using |
769 | +<ulink url="https://bugs.kde.org/"/>. |
770 | </para> |
771 | <note><title>Register first</title> |
772 | <para> |
773 | To report a bug, one must register for an account on the bug tracker. |
774 | -KDE's bug tracker is located at <ulink url="https://bugs.kde.org/"/>. |
775 | +<trademark>KDE</trademark>'s bug tracker is located at <ulink |
776 | +url="https://bugs.kde.org/"/>. |
777 | </para> |
778 | </note> |
779 | <procedure><title>Filing a bug report without a crash</title> |
780 | <step> |
781 | <para> |
782 | -In a web browser, go to <ulink url="https://bugs.kde.org/"/> and either |
783 | -create a new account or login. Once logged in, the following page will be |
784 | -presented. |
785 | +In a web browser, go to <ulink url="https://bugs.kde.org/"/> and either create |
786 | +a new account or log in. Once logged in, the following page will be presented: |
787 | </para> |
788 | <para> |
789 | <example><title>Welcome to the KDE Bug Tracking System</title> |
790 | @@ -605,8 +644,8 @@ |
791 | <step> |
792 | <para> |
793 | <mousebutton>Click</mousebutton> the <guilabel>Report New Wish or Bug</guilabel> |
794 | -link in the top-right-hand corner of the page to start the process of filing the |
795 | -bug report. The following page will be presented. |
796 | +link in the top right-hand corner of the page to start the process of filing |
797 | +the bug report. The following page will be presented: |
798 | </para> |
799 | <para> |
800 | <example><title>Welcome to the KDE Bug Report Wizard!</title> |
801 | @@ -620,8 +659,8 @@ |
802 | </step> |
803 | <step> |
804 | <para> |
805 | -<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. The |
806 | -following page will be presented. |
807 | +<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. |
808 | +The following page will be presented: |
809 | </para> |
810 | <para> |
811 | <example><title>Software Configuration</title> |
812 | @@ -639,7 +678,7 @@ |
813 | <guilabel>Distribution Method</guilabel> (Should be <guilabel>Ubuntu |
814 | Packages</guilabel>) from the drop-down menus. <mousebutton>Click</mousebutton> |
815 | the <guibutton>Continue</guibutton> button when finished with the selections. |
816 | -The following page will be presented. |
817 | +The following page will be presented: |
818 | </para> |
819 | <para> |
820 | <example><title>Application Selection</title> |
821 | @@ -660,10 +699,10 @@ |
822 | </step> |
823 | <step> |
824 | <para> |
825 | -Under the <guilabel>Find</guilabel> section under the |
826 | -<guilabel>Application</guilabel> list, fill in the <guilabel>Keyword |
827 | +Under the <guilabel>Find</guilabel> section in the |
828 | +<guilabel>Application</guilabel> list, fill in the <guilabel>Keyword |
829 | Search</guilabel> text box with the application being reported. It should look |
830 | -similar to the following image. |
831 | +similar to the following image: |
832 | </para> |
833 | <para> |
834 | <example><title>Application Selection (Search for application)</title> |
835 | @@ -681,8 +720,8 @@ |
836 | </step> |
837 | <step> |
838 | <para> |
839 | -<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. The |
840 | -following page will be presented. |
841 | +<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. |
842 | +The following page will be presented: |
843 | </para> |
844 | <para> |
845 | <example><title>General Information</title> |
846 | @@ -700,7 +739,7 @@ |
847 | information similar to the example under the text box. Select |
848 | <guilabel>Linux</guilabel> in the <guilabel>Operating System</guilabel> |
849 | drop-down menu. When completed, <mousebutton>Click</mousebutton> the |
850 | -<guibutton>Continue</guibutton> button. The following page will be presented. |
851 | +<guibutton>Continue</guibutton> button. The following page will be presented: |
852 | </para> |
853 | <para> |
854 | <example><title>Check for Duplicate Bug Reports</title> |
855 | @@ -714,12 +753,12 @@ |
856 | </step> |
857 | <step> |
858 | <para> |
859 | -If a duplicate report is found, click on that report ID to view the report. If |
860 | -it is a duplicate and more information is needed, then simply enter text in the |
861 | -large text box confirming it. If more information is not needed, nothing need |
862 | -be entered. If no duplicate reports are found, <mousebutton>Click</mousebutton> |
863 | -the <guibutton>Continue</guibutton> button. The following page will be |
864 | -presented. |
865 | +If a duplicate report is found, click on that report <acronym>ID</acronym> to |
866 | +view the report. If it is a duplicate and more information is needed, then |
867 | +enter text into the large text box confirming it. If more information is not |
868 | +needed, nothing needs to be entered. If no duplicate reports are found, |
869 | +<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. |
870 | +The following page will be presented: |
871 | </para> |
872 | <para> |
873 | <example><title>Bug Entry Form</title> |
874 | @@ -734,11 +773,11 @@ |
875 | <step> |
876 | <para> |
877 | The <guilabel>Severity</guilabel> (required) drop-down menu should display the |
878 | -<guilabel>Bug - Bug report (no crashes)</guilabel> option. In the <guilabel>Long |
879 | -Description in English</guilabel> (required) text box, enter all information |
880 | -pertaining to the bug report. When completed, <mousebutton>Click</mousebutton> |
881 | -the <guibutton>Continue</guibutton> button. The following page will be |
882 | -presented. |
883 | +<guilabel>Bug - Bug report (no crashes)</guilabel> option. In the |
884 | +<guilabel>Long Description in English</guilabel> (required) text box, enter all |
885 | +information pertaining to the bug report. When completed, |
886 | +<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. |
887 | +The following page will be presented: |
888 | </para> |
889 | <para> |
890 | <example><title>Bug Submitted</title> |
891 | @@ -752,27 +791,30 @@ |
892 | </step> |
893 | </procedure> |
894 | <para> |
895 | -<emphasis role="bold">Congratulations on making a successful non-crash related |
896 | -bug report!</emphasis> Identifying and reporting bugs are essential to improving |
897 | -&kubuntu; and KDE. Some emails may be sent to the registered address to update |
898 | -progress or to allow developers to get additional information about the bug. |
899 | +<emphasis>Congratulations on making a successful non-crash-related bug |
900 | +report!</emphasis> Identifying and reporting bugs are essential to improving |
901 | +&kubuntu; and <trademark>KDE</trademark>. Some emails may be sent to the |
902 | +registered address to update progress or to allow developers to get additional |
903 | +information about the bug. |
904 | </para> |
905 | </sect2> |
906 | <sect2 id="filing-non-crash-lp"> |
907 | <title>Launchpad</title> |
908 | <para> |
909 | -Filing non-crash related bug reports in non-KDE applications can be done either |
910 | -by going to <ulink url="https://bugs.launchpad.net/ubuntu/+filebug"/> in a web |
911 | -browser or by using the <application>Apport</application> bug reporting |
912 | -application. The following procedure will demonstrate the use of |
913 | -<application>Apport</application> as this is the recommended way of filing |
914 | -Ubuntu or non-KDE related bug reports. |
915 | +Filing non-crash-related bug reports in non-<trademark>KDE</trademark> |
916 | +applications can be done either by going to <ulink |
917 | +url="https://bugs.launchpad.net/ubuntu/+filebug"/> in a web browser or by using |
918 | +the <application>Apport</application> bug reporting application. The following |
919 | +procedure will demonstrate the use of <application>Apport</application> as this |
920 | +is the recommended way of filing &ubuntu; or |
921 | +non-<trademark>KDE</trademark>-related bug reports: |
922 | </para> |
923 | <procedure><title>Filing a bug report without a crash</title> |
924 | <step> |
925 | <para> |
926 | -Open <application>KRunner</application>, the KDE run command interface, by |
927 | -pressing <keycombo><keycap>Alt</keycap><keycap>F2</keycap></keycombo>. |
928 | +Open <application>KRunner</application>, the <trademark>KDE</trademark> run |
929 | +command interface, by pressing |
930 | +<keycombo><keycap>Alt</keycap><keycap>F2</keycap></keycombo>. |
931 | </para> |
932 | <para> |
933 | <example><title>KRunner</title> |
934 | @@ -786,10 +828,11 @@ |
935 | </step> |
936 | <step> |
937 | <para> |
938 | -In the <application>KRunner</application> dialog, enter <userinput>apport-bug -p |
939 | -PROGRAM_NAME</userinput>. Replace <emphasis>PROGRAM_NAME</emphasis> with the |
940 | -name of the program the bug report is for. Press <keycap>Enter</keycap> when |
941 | -complete. The following dialog will be presented. |
942 | +In the <application>KRunner</application> dialog, enter |
943 | +<userinput>apport-bug -p PROGRAM_NAME</userinput>. Replace |
944 | +<emphasis>PROGRAM_NAME</emphasis> with the name of the program the bug report |
945 | +is for. Press <keycap>Enter</keycap> when complete. The following dialog will |
946 | +be presented: |
947 | </para> |
948 | <para> |
949 | <example><title>Collecting Problem Information</title> |
950 | @@ -818,9 +861,9 @@ |
951 | </step> |
952 | <step> |
953 | <para> |
954 | -<mousebutton>Click</mousebutton> the <guibutton>Details...</guibutton> button to |
955 | -see details of the report to be followed. The following dialog will be |
956 | -presented. |
957 | +<mousebutton>Click</mousebutton> the <guibutton>Details...</guibutton> button |
958 | +to see details of the report to be followed. The following dialog will be |
959 | +presented: |
960 | </para> |
961 | <para> |
962 | <example><title>Report Details</title> |
963 | @@ -835,7 +878,7 @@ |
964 | <step> |
965 | <para> |
966 | <mousebutton>Click</mousebutton> the <guibutton>Send</guibutton> button to send |
967 | -the report to the developers. The following progress dialog will be presented. |
968 | +the report to the developers. The following progress dialog will be presented: |
969 | </para> |
970 | <para> |
971 | <example><title>Uploading Problem Information</title> |
972 | @@ -850,7 +893,7 @@ |
973 | <step> |
974 | <para> |
975 | After the information has been uploaded, the web browser will open and display |
976 | -a page similar to the following. |
977 | +a page similar to the following: |
978 | </para> |
979 | <para> |
980 | <example><title>Please wait while bug data is processed.</title> |
981 | @@ -862,7 +905,7 @@ |
982 | </example> |
983 | </para> |
984 | <para> |
985 | -After the bug data is processed, the following page will be presented. |
986 | +After the bug data is processed, the following page will be presented: |
987 | </para> |
988 | <para> |
989 | <example><title>Report a bug... (Summary)</title> |
990 | @@ -876,9 +919,9 @@ |
991 | </step> |
992 | <step> |
993 | <para> |
994 | -Enter text in the <guilabel>Summary</guilabel> text box that describes the bug |
995 | -with a few words. When finished, <mousebutton>Click</mousebutton> the |
996 | -<guibutton>Next</guibutton> button. The following page will be presented. |
997 | +Enter text that describes the bug into the <guilabel>Summary</guilabel> text |
998 | +box. When finished, <mousebutton>Click</mousebutton> the |
999 | +<guibutton>Next</guibutton> button. The following page will be presented: |
1000 | </para> |
1001 | <para> |
1002 | <example><title>Report a bug... (Further information)</title> |
1003 | @@ -895,7 +938,7 @@ |
1004 | Enter text in the <guilabel>Further information</guilabel> text box describing |
1005 | the bug in detail. When complete, <mousebutton>Click</mousebutton> the |
1006 | <guibutton>Submit Bug Report</guibutton> button. The following page will be |
1007 | -presented. |
1008 | +presented: |
1009 | </para> |
1010 | <para> |
1011 | <example><title>Thank you for your bug report</title> |
1012 | @@ -909,8 +952,8 @@ |
1013 | </step> |
1014 | </procedure> |
1015 | <para> |
1016 | -<emphasis role="bold">Congratulations on making a successful non-crash related |
1017 | -bug report!</emphasis> Identifying and reporting bugs are essential to improving |
1018 | +<emphasis>Congratulations on making a successful non-crash related bug |
1019 | +report!</emphasis> Identifying and reporting bugs are essential to improving |
1020 | &kubuntu;. Some emails may be sent to the registered address to update progress |
1021 | or to allow developers to get additional information about the bug. |
1022 | </para> |
1023 | @@ -920,21 +963,24 @@ |
1024 | <sect1 id="filing-wishlist"> |
1025 | <title>Filing a Feature Request or Wishlist Report</title> |
1026 | <para> |
1027 | -The easiest way to request a new feature in either an application or the |
1028 | -operating system is to file a bug, otherwise known as a wishlist report. |
1029 | +The easiest way to request a new feature, in either an application or the |
1030 | +operating system, is to file a bug — otherwise known as a wishlist |
1031 | +report. |
1032 | </para> |
1033 | <sect2 id="filing-wishlist-kde"> |
1034 | <title>KDE</title> |
1035 | <para> |
1036 | -Filing a feature request report in KDE is exactly the same as filing a <link |
1037 | -linkend="filing-non-crash-kde">non-crash KDE bug report</link>. |
1038 | +Filing a feature request report in <trademark>KDE</trademark> is exactly the |
1039 | +same as filing a <link linkend="filing-non-crash-kde">non-crash |
1040 | +<trademark>KDE</trademark> bug report</link>. |
1041 | </para> |
1042 | </sect2> |
1043 | <sect2 id="filing-wishlist-lp"> |
1044 | <title>Launchpad</title> |
1045 | <para> |
1046 | Filing a wishlist report for &kubuntu; is exactly the same as filing a <link |
1047 | -linkend="filing-non-crash-lp">non-crash Launchpad bug report</link>. |
1048 | +linkend="filing-non-crash-lp">non-crash <trademark>Launchpad</trademark> bug |
1049 | +report</link>. |
1050 | </para> |
1051 | </sect2> |
1052 | </sect1> |
1053 | |
1054 | === modified file 'docs/cli/C/cli.xml' |
1055 | --- docs/cli/C/cli.xml 2011-09-04 21:26:14 +0000 |
1056 | +++ docs/cli/C/cli.xml 2012-03-22 06:58:18 +0000 |
1057 | @@ -13,9 +13,9 @@ |
1058 | &legalnotice; |
1059 | <abstract> |
1060 | <para> |
1061 | -This document provides a brief description of the Linux command line. It is not |
1062 | -a complete guide to the command line, but rather an introduction to complement |
1063 | -&kubuntu;'s graphical tools. |
1064 | +This document provides a brief description of the <trademark>Linux</trademark> |
1065 | +command line. It is not a complete guide, but rather an introduction to |
1066 | +complement &kubuntu;'s graphical tools. |
1067 | </para> |
1068 | </abstract> |
1069 | </articleinfo> |
1070 | @@ -25,37 +25,41 @@ |
1071 | |
1072 | <para> |
1073 | <emphasis> |
1074 | -"Under Linux there are GUIs (graphical user interfaces), where you can point and |
1075 | -click and drag, and hopefully get work done without first reading lots of |
1076 | -documentation. The traditional Unix environment is a CLI (command line |
1077 | -interface), where you type commands to tell the computer what to do. That is |
1078 | -faster and more powerful, but requires finding out what the commands are." -- |
1079 | -from <emphasis role="strong">man intro(1)</emphasis> |
1080 | +"Under <trademark>Linux</trademark> there are <acronym>GUI</acronym>s |
1081 | +(graphical user interfaces), where you can point and click and drag and |
1082 | +hopefully get work done without first reading lots of documentation. The |
1083 | +traditional <trademark>Unix</trademark> environment is a |
1084 | +<acronym>CLI</acronym> (command line interface), where you type commands to |
1085 | +tell the computer what to do. That is faster and more powerful, but requires |
1086 | +finding out what the commands are." -- from <emphasis>man intro(1)</emphasis> |
1087 | </emphasis> |
1088 | </para> |
1089 | <para> |
1090 | -This guide describes some basic GNU/Linux shell commands. It is not intended to |
1091 | -be a complete guide to the command line, just an introduction to complement |
1092 | -&kubuntu;'s graphical tools. |
1093 | +This guide describes some basic <trademark>GNU</trademark>/ |
1094 | +<trademark>Linux</trademark> shell commands. It is not intended to be a |
1095 | +complete guide to the command line, just an introduction to complement |
1096 | +&kubuntu;'s graphical tools. |
1097 | </para> |
1098 | <para> |
1099 | <itemizedlist> |
1100 | <listitem> |
1101 | <para> |
1102 | -All command names, file names or paths to directories will be shown using a <command>monospace font</command>. |
1103 | +All command names, file names, or paths to directories will be shown using a |
1104 | +<command>monospace font</command>. |
1105 | </para> |
1106 | </listitem> |
1107 | <listitem> |
1108 | <para> |
1109 | -The commands should be issued from a command prompt within a |
1110 | +The commands should be issued from a command prompt within a |
1111 | <application>Terminal</application> and will be shown as: |
1112 | <screen>command to type</screen> |
1113 | </para> |
1114 | </listitem> |
1115 | <listitem> |
1116 | <para> |
1117 | -<emphasis role="strong">Command Line Linux is case sensitive.</emphasis> User, |
1118 | -user, and USER are each different and distinct in Linux. |
1119 | +<emphasis>Command Line <trademark>Linux</trademark> is case |
1120 | +sensitive.</emphasis> User, user, and USER are each different and distinct in |
1121 | +<trademark>Linux</trademark>. |
1122 | </para> |
1123 | </listitem> |
1124 | </itemizedlist> |
1125 | @@ -65,12 +69,12 @@ |
1126 | <sect1 id="terminal"> |
1127 | <title>Starting A Terminal</title> |
1128 | <para> |
1129 | -&kubuntu;'s Terminal application is called |
1130 | -<application>Konsole</application>, and is opened by going to &menukonsole;. |
1131 | +&kubuntu;'s Terminal application is called <application>Konsole</application>, |
1132 | +and is opened by going to &menukonsole;. |
1133 | </para> |
1134 | <para> |
1135 | <example> |
1136 | -<title>&kubuntu;'s terminal - Konsole</title> |
1137 | +<title>&kubuntu;'s terminal - Konsole</title> |
1138 | <mediaobject> |
1139 | <imageobject> |
1140 | <imagedata fileref="help:/images/C/C/konsole.png" format="PNG"/> |
1141 | @@ -86,12 +90,10 @@ |
1142 | <sect2 id="pwd"> |
1143 | <title>pwd - print working directory</title> |
1144 | <para> |
1145 | -The <command>pwd</command> command displays the directory where the user is |
1146 | -currently |
1147 | -located. (<acronym>pwd</acronym> stands for <quote>print working |
1148 | -directory</quote>). For example, typing |
1149 | -<screen>pwd</screen> while in the <filename |
1150 | -class="directory">Desktop</filename> will show |
1151 | +The <command>pwd</command> command displays the directory where the user is |
1152 | +currently located. (<acronym>pwd</acronym> stands for <quote>print working |
1153 | +directory</quote>). For example, typing <screen>pwd</screen> while in the |
1154 | +<filename class="directory">Desktop</filename> directory will show |
1155 | <computeroutput>/home/[username]/Desktop</computeroutput>. |
1156 | <note> |
1157 | <para> |
1158 | @@ -105,9 +107,9 @@ |
1159 | <title>cd - change directory</title> |
1160 | <para> |
1161 | The <command>cd</command> command changes directories. (<acronym>cd</acronym> |
1162 | -stands for |
1163 | -<quote>change directory</quote>). When a terminal window is opened, it will be in the user's home directory. Moving around the file system requires the |
1164 | -use of the <command>cd</command>. |
1165 | +stands for <quote>change directory</quote>). When a terminal window is opened, |
1166 | +it will be in the user's home directory. Moving around the file system requires |
1167 | +the use of the <command>cd</command> command. |
1168 | </para> |
1169 | <itemizedlist> |
1170 | <listitem> |
1171 | @@ -125,8 +127,8 @@ |
1172 | </para> |
1173 | <note> |
1174 | <para> |
1175 | -The <command>~</command> character represents the current user's home directory. |
1176 | -As shown above, <command>cd ~</command> is equivalent to <command>cd |
1177 | +The <command>~</command> character represents the current user's home |
1178 | +directory. As shown above, <command>cd ~</command> is equivalent to <command>cd |
1179 | /home/username/</command>. However, when running a command as root (using |
1180 | <command>sudo</command>, for example), <command>~</command> points to <filename |
1181 | class="directory">/root</filename>. When running a <command>cd</command> command |
1182 | @@ -161,8 +163,8 @@ |
1183 | of <filename class="directory">/var/</filename>. For another example, typing: |
1184 | <screen>cd ~/Desktop</screen> |
1185 | moves to the <filename |
1186 | -class="directory">Desktop</filename> subdirectory inside the current user's home |
1187 | -directory. |
1188 | +class="directory">Desktop</filename> subdirectory inside the current user's |
1189 | +home directory. |
1190 | </para> |
1191 | </listitem> |
1192 | </itemizedlist> |
1193 | @@ -171,11 +173,9 @@ |
1194 | <title>ls - list files</title> |
1195 | <para> |
1196 | The <command>ls</command> command outputs a list of the files in the current |
1197 | -directory. (<acronym>ls</acronym> is short for <quote>list</quote>). For example, |
1198 | -typing |
1199 | -<screen>ls ~</screen> |
1200 | -will display the files that are in the current |
1201 | -user's home directory. |
1202 | +directory. (<acronym>ls</acronym> is short for <quote>list</quote>). For |
1203 | +example, typing <screen>ls ~</screen> will display the files that are in the |
1204 | +current user's home directory. |
1205 | </para> |
1206 | <para> |
1207 | Used with the <command>-l</command> option, <command>ls</command> outputs other |
1208 | @@ -185,34 +185,34 @@ |
1209 | <para> |
1210 | Used with the <command>-al</command> options, <command>ls</command> outputs |
1211 | the information associated with the <command>-l</command> option in addition to |
1212 | -showing hidden files (<command>a</command> |
1213 | -option). |
1214 | +showing hidden files (<command>a</command> option). |
1215 | </para> |
1216 | </sect2> |
1217 | <sect2 id="touch"> |
1218 | <title>touch - create empty file</title> |
1219 | <para> |
1220 | -The <command>touch</command> command is used either to change a file's access |
1221 | -and modification timestamps or to create a new empty file. For example, |
1222 | -<screen>touch foo</screen> |
1223 | -will create a new empty file named <filename>foo</filename>. If |
1224 | -<filename>foo</filename> is already a file, then using <command>touch</command> |
1225 | -will update the timestamps on the file which will show |
1226 | -the last time a file was <emphasis>touched</emphasis>. |
1227 | +The <command>touch</command> command is used to change a file's access and |
1228 | +modification timestamps or to create a new empty file. For example, |
1229 | +<screen>touch foo</screen> will create a new empty file named |
1230 | +<filename>foo</filename>. If <filename>foo</filename> is already a file, then |
1231 | +using <command>touch</command> will update the timestamps on the file, which |
1232 | +show the last time a file was <emphasis>touched</emphasis>. |
1233 | </para> |
1234 | </sect2> |
1235 | <sect2 id="mkdir"> |
1236 | <title>mkdir - make directory</title> |
1237 | <para> |
1238 | -The <command>mkdir</command> command is used to create a new directory. (<acronym>mkdir</acronym> stands for <quote>make directory</quote>). To create a |
1239 | -new directory named <filename class="directory">foobar</filename>, type: |
1240 | +The <command>mkdir</command> command is used to create a new directory. |
1241 | +(<acronym>mkdir</acronym> stands for <quote>make directory</quote>). To create |
1242 | +a new directory named <filename class="directory">foobar</filename>, type: |
1243 | <screen>mkdir foobar</screen> |
1244 | </para> |
1245 | </sect2> |
1246 | <sect2 id="cp"> |
1247 | <title>cp - copy files or directories</title> |
1248 | <para> |
1249 | -The <command>cp</command> command makes a copy of a file or directory. (<acronym>cp</acronym> is short for <quote>copy</quote>). To make an exact copy |
1250 | +The <command>cp</command> command makes a copy of a file or directory. |
1251 | +(<acronym>cp</acronym> is short for <quote>copy</quote>). To make an exact copy |
1252 | of <filename>foo</filename> and name it <filename>bar</filename>, type: |
1253 | <screen>cp foo bar</screen> |
1254 | To make an exact copy of the <filename class="directory">foo_dir</filename> |
1255 | @@ -224,34 +224,32 @@ |
1256 | <title>mv - move files or directories</title> |
1257 | <para> |
1258 | The <command>mv</command> command moves a file or directory to a different |
1259 | -location or will rename a file or directory. (<acronym>mv</acronym> is short for |
1260 | +location or renames a file or directory. (<acronym>mv</acronym> is short for |
1261 | <quote>move</quote>). To rename the file <filename>foo</filename> to |
1262 | -<filename>bar</filename>, type: |
1263 | -<screen>mv foo bar</screen> |
1264 | -To move the file <filename>foo</filename> into the current user's <filename |
1265 | -class="directory">Desktop</filename> directory, type: |
1266 | -<screen>mv foo ~/Desktop</screen> |
1267 | -This will not rename <filename>foo</filename> to <filename>Desktop</filename> |
1268 | -because <filename>foo</filename> is a file and <filename |
1269 | -class="directory">Desktop</filename> is a directory. |
1270 | +<filename>bar</filename>, type: <screen>mv foo bar</screen> To move the file |
1271 | +<filename>foo</filename> into the current user's <filename |
1272 | +class="directory">Desktop</filename> directory, type: <screen>mv foo |
1273 | +~/Desktop</screen> This will not rename <filename>foo</filename> to |
1274 | +<filename>Desktop</filename>, because <filename>foo</filename> is a file and |
1275 | +<filename class="directory">Desktop</filename> is a directory. |
1276 | </para> |
1277 | </sect2> |
1278 | <sect2 id="rm"> |
1279 | <title>rm - remove files or directories</title> |
1280 | <para> |
1281 | -The <command>rm</command> command is used to delete files and directories. (<acronym>rm</acronym> is short for <quote>remove</quote>). To delete the file |
1282 | -<filename>foo</filename> for the current directory, type: |
1283 | +The <command>rm</command> command is used to delete files and directories. |
1284 | +(<acronym>rm</acronym> is short for <quote>remove</quote>). To delete the file |
1285 | +<filename>foo</filename> from the current directory, type: |
1286 | <screen>rm foo</screen> |
1287 | </para> |
1288 | <para> |
1289 | By default, <command>rm</command> will not remove directories. To remove a |
1290 | -directory, you must use the <command>-r</command> option (also can be entered |
1291 | -as either <command>-R</command> or <command>--recursive</command>). For example, |
1292 | -<screen>rm -r foobar</screen> or |
1293 | -<screen>rm -R foobar</screen> or |
1294 | -<screen>rm --recursive foobar</screen> |
1295 | -will remove the directory <filename class="directory">foobar</filename>, |
1296 | -<emphasis role="strong"> and all of its contents!</emphasis> |
1297 | +directory, you must use the <command>-r</command> option (which can also be |
1298 | +entered as <command>-R</command> or <command>--recursive</command>). For |
1299 | +example, <screen>rm -r foobar</screen> or <screen>rm -R foobar</screen> or |
1300 | +<screen>rm --recursive foobar</screen> will remove the directory |
1301 | +<filename class="directory">foobar</filename> <emphasis> and all of its |
1302 | +contents!</emphasis> |
1303 | </para> |
1304 | </sect2> |
1305 | |
1306 | @@ -265,8 +263,7 @@ |
1307 | <para> |
1308 | The <command>df</command> command displays filesystem disk space usage for all |
1309 | partitions. (<acronym>df</acronym> stands for <quote>disk free</quote>). |
1310 | -<screen>df -h</screen> |
1311 | -will give information using megabytes |
1312 | +<screen>df -h</screen> will give information using megabytes |
1313 | (<abbrev>M</abbrev>) and gigabytes (<abbrev>G</abbrev>) instead of blocks |
1314 | (<command>-h</command> means <quote>human readable</quote>). |
1315 | </para> |
1316 | @@ -275,26 +272,24 @@ |
1317 | <title>free - display amount of free and used memory</title> |
1318 | <para> |
1319 | The <command>free</command> command displays the amount of free and used memory |
1320 | -in the system. |
1321 | -<screen>free -m</screen> |
1322 | -will give the information using megabytes, which is probably the most useful for |
1323 | -current computers. |
1324 | +in the system. <screen>free -m</screen> will give the information using |
1325 | +megabytes, which is probably the most useful for current computers. |
1326 | </para> |
1327 | </sect2> |
1328 | <sect2 id="top"> |
1329 | <title>top - display top consuming processes</title> |
1330 | <para> |
1331 | -The <command>top</command> command displays information on the Linux system - |
1332 | -processes that are running, system resources including <acronym>CPU</acronym>, |
1333 | -<acronym>RAM</acronym> & swap usage, and the total number of tasks being |
1334 | -run. To |
1335 | -exit <command>top</command>, press <keycap>q</keycap>. |
1336 | +The <command>top</command> command displays information on the |
1337 | +<trademark>Linux</trademark> system - processes that are running, system |
1338 | +resources including <acronym>CPU</acronym>, <acronym>RAM</acronym> & swap |
1339 | +usage, and the total number of tasks being run. To exit <command>top</command>, |
1340 | +press <keycap>q</keycap>. |
1341 | </para> |
1342 | </sect2> |
1343 | <sect2 id="uname"> |
1344 | <title>uname - print details about the current machine</title> |
1345 | <para> |
1346 | -The <command>uname</command> command with the <command>-a</command> options |
1347 | +The <command>uname</command> command with the <command>-a</command> option |
1348 | displays all system information, including machine name, kernel name & |
1349 | version, and other details. This command is useful for checking which kernel is |
1350 | in use. (<abbrev>uname</abbrev> is short for <quote>unix name</quote>). |
1351 | @@ -304,8 +299,8 @@ |
1352 | <title>lsb_release - print details about current Linux release</title> |
1353 | <para> |
1354 | The <command>lsb_release</command> with the <command>-a</command> option prints |
1355 | -version information for the Linux release in use. For example, typing: |
1356 | -<screen>lsb_release -a</screen> will display: |
1357 | +version information for the <trademark>Linux</trademark> release in use. For |
1358 | +example, typing: <screen>lsb_release -a</screen> will display: |
1359 | <screen>No LSB modules are available. |
1360 | Distributor ID: Ubuntu |
1361 | Description: Ubuntu &distro-rev; |
1362 | @@ -323,49 +318,41 @@ |
1363 | The following commands must be prefaced with the |
1364 | <command>sudo</command> command. Please see <ulink |
1365 | url="https://help.ubuntu.com/community/RootSudo">RootSudo</ulink> for |
1366 | -information on using <command>sudo</command>. (<abbrev>sudo</abbrev> is short for |
1367 | -<quote>superuser do</quote>). |
1368 | +information on using <command>sudo</command>. (<abbrev>sudo</abbrev> is short |
1369 | +for <quote>superuser do</quote>). |
1370 | </para> |
1371 | <sect2 id="add-group"> |
1372 | <title>Adding a New Group</title> |
1373 | <para> |
1374 | The <command>addgroup</command> command is used to create a new group in the |
1375 | -system. To create a new group, type: |
1376 | -<screen>sudo addgroup foobar</screen> |
1377 | -The above command will create a new group called <emphasis |
1378 | -role="strong">foobar</emphasis>. |
1379 | +system. To create a new group, type: <screen>sudo addgroup foobar</screen> The |
1380 | +above command will create a new group called <emphasis>foobar</emphasis>. |
1381 | </para> |
1382 | </sect2> |
1383 | <sect2 id="add-user"> |
1384 | <title>Adding a New User</title> |
1385 | <para> |
1386 | The <command>adduser</command> command is used to create a new user on the |
1387 | -system. To create a new user, type: |
1388 | -<screen>adduser foobar</screen> |
1389 | -which will create a new user called <emphasis role="strong">foobar</emphasis>. |
1390 | +system. To create a new user, type: <screen>adduser foobar</screen> which will |
1391 | +create a new user called <emphasis>foobar</emphasis>. |
1392 | </para> |
1393 | </sect2> |
1394 | <sect2 id="passwd"> |
1395 | <title>Add or Change a User Password</title> |
1396 | <para> |
1397 | The <command>passwd</command> command is used to assign a new password to a |
1398 | -new user or to change the current password for an existing user. To add a |
1399 | -password or change the password for the user <emphasis |
1400 | -role="strong">foobar</emphasis>, |
1401 | -type: |
1402 | -<screen>passwd foobar</screen> |
1403 | -For new users, this will generate a prompt to enter the new password. For |
1404 | -an |
1405 | -existing user, there will be a prompt for the existing password before the |
1406 | -prompt for a new password. |
1407 | +new user or change the current password for an existing user. To add a password |
1408 | +or change the password for the user <emphasis>foobar</emphasis>, type: |
1409 | +<screen>passwd foobar</screen> For new users, this will generate a prompt to |
1410 | +enter the new password. For an existing user, there will be a prompt for the |
1411 | +existing password before the prompt for a new password. |
1412 | </para> |
1413 | </sect2> |
1414 | <sect2 id="assign-user-group"> |
1415 | <title>Assign User to Group</title> |
1416 | <para> |
1417 | -To assign the user <emphasis role="strong">foobar</emphasis> to the group |
1418 | -<emphasis role="strong">barfoo</emphasis>, type: |
1419 | -<screen>adduser foobar barfoo</screen> |
1420 | +To assign the user <emphasis>foobar</emphasis> to the group |
1421 | +<emphasis>barfoo</emphasis>, type: <screen>adduser foobar barfoo</screen> |
1422 | </para> |
1423 | </sect2> |
1424 | </sect1> |
1425 | @@ -374,20 +361,20 @@ |
1426 | <sect1 id="options"> |
1427 | <title>Options</title> |
1428 | <para> |
1429 | -The default behavior for a command may usually be modified by adding <command>--option</command> to the command. For example, the <link |
1430 | -linkend="ls"><command>ls</command></link> command has an |
1431 | -<command>-s</command> option. The <command>ls -s</command> will include file |
1432 | -sizes in the listing. There is also a <command>-h</command> option to display |
1433 | -file sizes in a <quote>human readable</quote> format. |
1434 | +The default behavior for a command may usually be modified by adding |
1435 | +<command>--option</command> to the command. For example, the <link |
1436 | +linkend="ls"><command>ls</command></link> command has an <command>-s</command> |
1437 | +option. The <command>ls -s</command> will include file sizes in the listing. |
1438 | +There is also a <command>-h</command> option to display file sizes in a |
1439 | +<quote>human readable</quote> format. |
1440 | </para> |
1441 | <para> |
1442 | Options can be grouped in clusters, so |
1443 | <screen>ls -sh</screen> |
1444 | is the same command as |
1445 | <screen> ls -s -h</screen> |
1446 | -Most options have a long version, prefixed with two dashes instead of one, so |
1447 | -<screen>ls --size --human-readable</screen> |
1448 | -is also the same command as |
1449 | +Most options have a long version prefixed with two dashes instead of one, so |
1450 | +<screen>ls --size --human-readable</screen> is the same command as |
1451 | <screen>ls -sh</screen> |
1452 | </para> |
1453 | </sect1> |
1454 | @@ -396,14 +383,13 @@ |
1455 | <sect1 id="man-help"> |
1456 | <title><quote>Man</quote> and Getting Help</title> |
1457 | <para> |
1458 | -<emphasis role="strong"><emphasis>command</emphasis> --help</emphasis> and |
1459 | -<command>man</command> <emphasis |
1460 | -role="strong"><emphasis>command</emphasis></emphasis> are the two most important |
1461 | +<emphasis><emphasis>command</emphasis> --help</emphasis> and |
1462 | +<command>man</command> <emphasis>command</emphasis> are the two most important |
1463 | tools at the command line. |
1464 | </para> |
1465 | <para> |
1466 | Virtually all commands understand the <command>-h</command> (or |
1467 | -<command>--help</command>) option which will produce a short usage description |
1468 | +<command>--help</command>) option, which will produce a short usage description |
1469 | of the command and its options, then exit back to the command prompt. Type: |
1470 | <screen>man -h</screen> |
1471 | or |
1472 | @@ -411,33 +397,29 @@ |
1473 | to see this in action. |
1474 | </para> |
1475 | <para> |
1476 | -Every command and nearly every application in Linux has a |
1477 | -<abbrev>man</abbrev> (manual) file. It is as simple as typing <command>man |
1478 | +Every command and nearly every application in <trademark>Linux</trademark> has |
1479 | +a <abbrev>man</abbrev> (manual) file. It is as simple as typing <command>man |
1480 | command</command> to bring up a longer manual entry for the specified command. |
1481 | -For example: |
1482 | -<screen>man mv</screen> |
1483 | -brings up the <command>mv</command> manual. |
1484 | +For example: <screen>man mv</screen> brings up the <command>mv</command> |
1485 | +manual. |
1486 | </para> |
1487 | <para> |
1488 | Move up and down the man file with the arrow keys, and quit back to the command |
1489 | prompt with <keycap>q</keycap>. |
1490 | </para> |
1491 | <para> |
1492 | -<screen>man man</screen> |
1493 | -brings up the manual entry for the <command>man</command> command, which is a |
1494 | -good place to start. |
1495 | +<screen>man man</screen> brings up the manual entry for the |
1496 | +<command>man</command> command, which is a good place to start. |
1497 | </para> |
1498 | <para> |
1499 | -<screen>man intro</screen> |
1500 | -is especially useful. It displays the <quote>introduction to user |
1501 | -commands</quote> which is a well-written, brief introduction to the Linux |
1502 | -command line. |
1503 | +<screen>man intro</screen> is especially useful. It displays the |
1504 | +<quote>introduction to user commands</quote> which is a well-written, brief |
1505 | +introduction to the <trademark>Linux</trademark> command line. |
1506 | </para> |
1507 | <para> |
1508 | There are also <command>info</command> pages, which generally go into more |
1509 | -detail than <command>man</command> pages. Try: |
1510 | -<screen>info info</screen> |
1511 | -for the introduction to info pages. |
1512 | +detail than <command>man</command> pages. Try: <screen>info info</screen> for |
1513 | +the introduction to info pages. |
1514 | </para> |
1515 | <sect2 id="searching-for-man-files"> |
1516 | <title>Searching for man files</title> |
1517 | @@ -473,14 +455,14 @@ |
1518 | There are often situations that require text to be pasted into the terminal. |
1519 | </para> |
1520 | <para> |
1521 | -Text copied from a web page using |
1522 | +Text copied from a web page using |
1523 | <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> won't paste with |
1524 | <keycombo><keycap>Ctrl</keycap><keycap>V</keycap></keycombo> as it does in |
1525 | -other applications because the |
1526 | -terminal uses a different combination for paste, |
1527 | -<keycombo><keycap>Shift</keycap><keycap>Insert</keycap></keycombo>. Pasting can |
1528 | -also be done using the mouse by <mousebutton>right-clicking</mousebutton> in |
1529 | -the terminal and selecting <guimenuitem>Paste</guimenuitem> from the menu. |
1530 | +other applications, because the terminal uses the |
1531 | +<keycombo><keycap>Shift</keycap><keycap>Insert</keycap></keycombo> |
1532 | +combination. Pasting can also be done using the mouse by |
1533 | +<mousebutton>right-clicking</mousebutton> in the terminal and selecting |
1534 | +<guimenuitem>Paste</guimenuitem> from the menu. |
1535 | </para> |
1536 | <para> |
1537 | Text can also be copied by selecting (highlighting) the text to be copied. |
1538 | @@ -490,8 +472,9 @@ |
1539 | </para> |
1540 | <note> |
1541 | <para> |
1542 | -These actions may work differently in other terminal emulators than <application>Konsole</application>. |
1543 | -Consult your terminal emulator's documentation for details. |
1544 | +These actions may work differently in other terminal emulators than |
1545 | +<application>Konsole</application>. Consult your terminal emulator's |
1546 | +documentation for details. |
1547 | </para> |
1548 | </note> |
1549 | </sect1> |
1550 | @@ -507,7 +490,7 @@ |
1551 | </term> |
1552 | <listitem> |
1553 | <para> |
1554 | -Scrolls backwards through the commands entered previously |
1555 | +Scrolls backwards through the commands entered previously. |
1556 | </para> |
1557 | </listitem> |
1558 | </varlistentry> |
1559 | @@ -518,7 +501,7 @@ |
1560 | </term> |
1561 | <listitem> |
1562 | <para> |
1563 | -Scrolls forward through previous commands |
1564 | +Scrolls forward through previous commands. |
1565 | </para> |
1566 | </listitem> |
1567 | </varlistentry> |
1568 | @@ -528,7 +511,7 @@ |
1569 | </term> |
1570 | <listitem> |
1571 | <para> |
1572 | -Executes the command selected |
1573 | +Executes the selected command. |
1574 | </para> |
1575 | </listitem> |
1576 | </varlistentry> |
1577 | @@ -539,7 +522,7 @@ |
1578 | <listitem> |
1579 | <para> |
1580 | Tab is a useful feature. It autocompletes any commands or filenames if there is |
1581 | -one option, otherwise it displays a list of options that fit the information |
1582 | +one option. Otherwise it displays a list of options that fit the information |
1583 | entered. Using tab in this way reduces typing errors. |
1584 | </para> |
1585 | </listitem> |
1586 | @@ -567,7 +550,7 @@ |
1587 | </term> |
1588 | <listitem> |
1589 | <para> |
1590 | -Moves the cursor to the <emphasis>start</emphasis> of the line |
1591 | +Moves the cursor to the <emphasis>start</emphasis> of the line. |
1592 | </para> |
1593 | </listitem> |
1594 | </varlistentry> |
1595 | @@ -578,7 +561,7 @@ |
1596 | </term> |
1597 | <listitem> |
1598 | <para> |
1599 | -Moves the cursor to the <emphasis>end</emphasis> of the line |
1600 | +Moves the cursor to the <emphasis>end</emphasis> of the line. |
1601 | </para> |
1602 | </listitem> |
1603 | </varlistentry> |
1604 | @@ -588,7 +571,7 @@ |
1605 | </term> |
1606 | <listitem> |
1607 | <para> |
1608 | -Deletes from the current cursor position to the end of the line |
1609 | +Deletes from the current cursor position to the end of the line. |
1610 | </para> |
1611 | </listitem> |
1612 | </varlistentry> |
1613 | @@ -598,7 +581,7 @@ |
1614 | </term> |
1615 | <listitem> |
1616 | <para> |
1617 | -Deletes the entire current line |
1618 | +Deletes the entire current line. |
1619 | </para> |
1620 | </listitem> |
1621 | </varlistentry> |
1622 | @@ -608,7 +591,7 @@ |
1623 | </term> |
1624 | <listitem> |
1625 | <para> |
1626 | -Deletes the word before the cursor |
1627 | +Deletes the word before the cursor. |
1628 | </para> |
1629 | </listitem> |
1630 | </varlistentry> |
1631 | @@ -624,8 +607,8 @@ |
1632 | <itemizedlist> |
1633 | <listitem> |
1634 | <para> |
1635 | -<ulink url="https://help.ubuntu.com/community/AptGetHowto">AptGetHowto</ulink> - |
1636 | -using <command>apt-get</command> to install packages from the command line. |
1637 | +<ulink url="https://help.ubuntu.com/community/AptGetHowto">AptGetHowto</ulink> |
1638 | +- using <command>apt-get</command> to install packages from the command line. |
1639 | </para> |
1640 | </listitem> |
1641 | <listitem> |
1642 | @@ -653,25 +636,26 @@ |
1643 | <para> |
1644 | <ulink url="https://help.ubuntu.com/community/CommandlineHowto">Commandline |
1645 | Howto</ulink> - longer and more complete than this basic guide; still not |
1646 | -finished however. |
1647 | +finished, however. |
1648 | </para> |
1649 | </listitem> |
1650 | <listitem> |
1651 | <para> |
1652 | <ulink url="https://help.ubuntu.com/community/HowToReadline">Howto |
1653 | -Readline</ulink> - information on more advanced customization for the |
1654 | -command line. |
1655 | +Readline</ulink> - information on more advanced customization for the command |
1656 | +line. |
1657 | </para> |
1658 | </listitem> |
1659 | </itemizedlist> |
1660 | <para> |
1661 | -For more detailed tutorials on the Linux command line, please see: |
1662 | +For more detailed tutorials on the <trademark>Linux</trademark> command line, |
1663 | +please see: |
1664 | </para> |
1665 | <itemizedlist> |
1666 | <listitem> |
1667 | <para> |
1668 | -<ulink url="http://ss64.com/bash/"/> - an A-Z index of the Bash command line for |
1669 | -Linux. |
1670 | +<ulink url="http://ss64.com/bash/"/> - an A-Z index of the |
1671 | +<trademark>Bash</trademark> command line for <trademark>Linux</trademark>. |
1672 | </para> |
1673 | </listitem> |
1674 | <listitem> |
1675 | @@ -682,19 +666,20 @@ |
1676 | </listitem> |
1677 | <listitem> |
1678 | <para> |
1679 | -<ulink url="http://linuxsurvival.com/index.php" /> - Java-based tutorials. |
1680 | +<ulink url="http://linuxsurvival.com/index.php" /> - |
1681 | +<trademark>Java</trademark>-based tutorials. |
1682 | </para> |
1683 | </listitem> |
1684 | <listitem> |
1685 | <para> |
1686 | <ulink url="http://rute.2038bug.com/index.html.gz"/> - a massive online book |
1687 | -about system administration, almost all from the command line. |
1688 | +about system administration — almost all from the command line. |
1689 | </para> |
1690 | </listitem> |
1691 | <listitem> |
1692 | <para> |
1693 | -<ulink url="http://www.commandlinefu.com/"/> - a place to record command-line |
1694 | -favorites and view other's gems as well. |
1695 | +<ulink url="http://www.commandlinefu.com/"/> - a place to record command line |
1696 | +favorites and view others' gems as well. |
1697 | </para> |
1698 | </listitem> |
1699 | </itemizedlist> |