[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#565391: console-setup: typo in FAQ



tags 565391 + upstream patch
thanks

Hi,

Vincent Lefevre wrote:

> /usr/share/doc/console-setup/FAQ.gz says:

>    uption is to to use the "setupcon" utility whenever you need to
>    ^^^^^^
> 
> I suppose this should be "option".

Attached are two (mutually exclusive) patches to address this:

 * spell-check-FAQ only fixes spelling errors reported by hunspell.

 * copy-edit-FAQ fixes all the awkward usages I found in a read
   through the text.

I didn't touch the semantics (except to change "some distributions" to
"some setups" where the latter meaning was clearer) but I was tempted
to:

 1.1: update to reflect the current state of the i810 driver and
      in-kernel mode setting support

 2.2: mention this is a Linux limitation; point to upstream discussion
      about whether or how to fix it.  If there hasn't been such a
      discussion, there should be one. ;-)

 2.4: point out bug #547073.  That is an init bug, not a Linux bug, and
      it is already fixed in Debian testing.

What do you think?  I would be tempted to fix some of these and then
abuse the services of debian-l10n-en to clean up the result. :-)

Anyway, before then, perhaps one of the patches could be useful.

Hope that helps,
Jonathan
From: Jonathan Nieder <jrnieder@gmail.com>
Date: Sat, 16 Jan 2010 04:19:25 -0600
Subject: fix a few spelling errors in FAQ

Reported-by: Vincent Lefevre <vincent@vinc17.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---

diff -u console-setup-r62018/FAQ modified/FAQ
--- console-setup-r62018/FAQ
+++ modified/FAQ
@@ -2,7 +2,7 @@
 
      1) THE OUTPUT ON THE CONSOLE
    1.1) The font is broken after I switch to X and back to the console
-   1.2) The screen size is wrong.  The buttom 2-3 lines are cut off
+   1.2) The screen size is wrong.  The bottom 2-3 lines are cut off
    1.3) How can I load the big fonts?
    1.4) How to enlarge the image on the screen of my laptop?
    1.5) The symbols on the screen of my LCD are ugly
@@ -37,7 +37,7 @@
 
    Sometimes the problem doesn't exists at all.  It is rumored that
    some old video adapters (more than 10 years old) fall in this
-   category but I have never seen such videocard.
+   category but I have never seen such video card.
 
    The most common case seams to be that the state at the time the X
    server is started is remembered.  Try to setup the console before X
@@ -48,7 +48,7 @@
 
    And sometimes the console setup is never remembered.  In this case
    you will have to use framebuffer (try "modprobe vga16fb").  Another
-   uption is to to use the "setupcon" utility whenever you need to
+   option is to to use the "setupcon" utility whenever you need to
    restore the console setup and hope that the problem will be fixed
    in some future version of X Window.  You may want to send a bug
    report to the X developers.
@@ -66,7 +66,7 @@
    the options.
 
  
-1.2) The screen size is wrong.  The buttom 2-3 lines are cut off
+1.2) The screen size is wrong.  The bottom 2-3 lines are cut off
 
    The reason and the fix of the problem are the same as in the
    previous question.  I suppose you use X Window and you set on the
@@ -122,7 +122,7 @@
    laptop to scale the image and to use the whole screen.  For many
    laptops there is corresponding setting in the BIOS.
 
-   The second way is to use some high resolution framebufer mode in
+   The second way is to use some high resolution framebuffer mode in
    combination with some of the large fonts of console-setup.  The
    drawback is that the screen will be slow.
 
From: Jonathan Nieder <jrnieder@gmail.com>
Date: Sat, 16 Jan 2010 04:16:19 -0600
Subject: copy-edit FAQ

Tweak English usage (spelling, punctuation, and wording) to make
the text a little clearer.  No change in meaning intended.

Thanks to Vincent Lefevre <vincent@vinc17.net> for getting the
ball rolling.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---

diff -u console-setup-r62018/FAQ modified/FAQ
--- console-setup-r62018/FAQ
+++ modified/FAQ
@@ -1,197 +1,201 @@
-The following topics are addressed:
+This document addresses the following topics:
 
-     1) THE OUTPUT ON THE CONSOLE
-   1.1) The font is broken after I switch to X and back to the console
-   1.2) The screen size is wrong.  The buttom 2-3 lines are cut off
-   1.3) How can I load the big fonts?
-   1.4) How to enlarge the image on the screen of my laptop?
-   1.5) The symbols on the screen of my LCD are ugly
-   1.6) I can not use my boot splash screen program or SVGATextMode!
+   1) OUTPUT ON THE CONSOLE
+   1.1) The font is broken after I switch to X and back to the console.
+   1.2) The screen size is wrong.  The bottom 2-3 lines are cut off.
+   1.3) How can I use large font sizes?
+   1.4) How can I enlarge the image on my laptop display?
+   1.5) Display is ugly in text mode on my LCD.
+   1.6) I cannot use my boot splash screen program or SVGATextMode!
 
-     2) THE INPUT ON THE CONSOLE
+   2) INPUT ON THE CONSOLE
    2.1) I cannot type any non-ASCII character.  How do I fix the keymap?
-   2.2) The layouts toggle wrong when three keyboard layouts are set!
-   2.3) Where is the Dvorak keyboard?
-   2.4) Why the Backspace key doesn't work properly?
-   2.5) Why doesn't the CapsLock led work?
+   2.2) Toggling keyboard layouts misbehaves when three layouts are set up.
+   2.3) Where is the Dvorak keyboard layout?
+   2.4) Why doesn't the Backspace key doesn't work properly?
+   2.5) Why doesn't the Caps Lock LED turn on?
 
 
-1) THE OUTPUT ON THE CONSOLE
+1) OUTPUT ON THE CONSOLE
 
-1.1) The font is broken after I switch to X and back to the console
+1.1) The font is broken after I switch to X and back to the console.
 
-   Actually the boot-time font replaces the font of console-setup.  In
-   most cases this means the non-ASCII symbols are replaced by some
-   other funny symbols.
+   Actually the boot-time font replaces the font from console-setup.
+   In most cases, this means that non-ASCII symbols are replaced by
+   some other funny symbols.
 
-   This happens because sometimes the X video driver is unable to
-   restore properly the state of the console when you switch from X to
-   text-mode.  How severe the problem is depends on the combination
-   Video-card/X-driver you use.
+   This can sometimes happen because the X video driver is unable to
+   properly restore the state of the console when you switch from X to
+   text-mode.  How severe the problem is depends on the combination of
+   video card and X driver you use.
 
-   Notice that all this can happen only if the console is in
-   text-mode, i.e. you are not using framebuffer.  If you add to
-   /etc/modules the kernel module for framebuffer you will be able to
-   switch from X to console whenever you want and the font will never
-   be broken.
+   Notice that all of this can happen only if the console is in text
+   mode, or in other words, you are not using the framebuffer-based
+   console driver.  If you add the kernel module for framebuffer
+   access to your video card to /etc/modules, you will be able to
+   switch between X and the console whenever you want and the font
+   will never be broken.
 
    Sometimes the problem doesn't exists at all.  It is rumored that
    some old video adapters (more than 10 years old) fall in this
-   category but I have never seen such videocard.
+   category, but I have never seen such video card.
 
-   The most common case seams to be that the state at the time the X
-   server is started is remembered.  Try to setup the console before X
-   Window is started and if the problem disappears then you are in
-   this category.  The problem will reappear if you change the console
-   setup while X Window is already started.  All video adapters I have
-   had are in this category.
+   In the most common case, it is that the state at the time the X
+   server is started that is remembered.  Try to set up the console
+   before the X server is started; if the problem disappears, then you
+   are in this category.  The problem will reappear if you change the
+   console setup once X has already been started.  All video adapters
+   I have owned fall into this category.
 
-   And sometimes the console setup is never remembered.  In this case
-   you will have to use framebuffer (try "modprobe vga16fb").  Another
-   uption is to to use the "setupcon" utility whenever you need to
-   restore the console setup and hope that the problem will be fixed
-   in some future version of X Window.  You may want to send a bug
-   report to the X developers.
+   With some other cards and drivers, the console setup is never
+   remembered.  In this case, you will have to use the framebuffer
+   (try "modprobe vga16fb").  Another option is to run the "setupcon"
+   utility whenever you need to restore the console setup and hope
+   that the problem will be fixed in some future version of your X
+   video driver.  You may want to send a bug report to the X developers.
 
    Some chipsets might require specific video driver options in order
    to restore all console settings correctly. For example, if you
-   selected any font size other than 16 for console, it is necessary
-   to add the following line into "Device" section of xorg.conf when
+   selected any font size other than 16 for the console, you should
+   add the following line into "Device" section of xorg.conf when
    using i810 driver with some integrated graphics controllers:
 
       Option "VBERestore" "true"
 
-   Please, read 'man i810' (or 'man <your driver name>') for
-   additional information and, more importantly, for warnings on using
-   the options.
+   Please read 'man i810' (or 'man <your driver name>') for additional
+   information and, more importantly, for warnings on using the
+   options.
 
  
-1.2) The screen size is wrong.  The buttom 2-3 lines are cut off
+1.2) The screen size is wrong.  The bottom 2-3 lines are cut off.
 
-   The reason and the fix of the problem are the same as in the
-   previous question.  I suppose you use X Window and you set on the
-   console a font whose size is not the same as the size of the font
-   that was active when X Window was started.  Then the following
+   The cause and the fix for this problem are the same as for the
+   previous question.  I suppose you use the X Window System and you
+   chose a font for the console whose size is not the same as the size
+   of the font that was active when X started.  Then the following
    happens:
 
-      1. When X Window is started the X server remembers the active
-         font (let this be font A).
+      1. When X starts, the X server remembers the active font (let
+         this be font A).
 
-      2. You use the Ctrl+Alt+F1 combination and then you change the
-         font on the console (let this be font B).  However the X
-         server doesn't want to know about this.
+      2. You use the Ctrl+Alt+F1 combination and then change the font
+         on the console (let this be font B).  The X server doesn't
+         know about this.
 
       3. You return to X (Alt+F7).
 
-      4. Again Ctrl+Alt+F1.  The X server restores font A.  However
-         the kernel doesn't know that B is no more the active font.
+      4. Again Ctrl+Alt+F1.  The X server restores font A.  However,
+         the kernel doesn't know that B is not the active font any
+         more.
 
-      5. If font A has say 16 scan lines and font B has 14 scan lines
-         the font on the screen has 16 scan lines but the kernel
-         doesn't know this and draws the screen as if the scan lines
-         were only 14.  The result is that the bottom lines are
+      5. If, for example, font A has 16 scan lines and font B has 14
+         scan lines, then the font on the screen will have 16 scan
+         lines but the kernel doesn't know this and draws the screen
+         as if there were only 14.  As a result, the bottom lines are
          outside the screen.
 
 
-1.3) How can I load the big fonts?
+1.3) How can I use large font sizes?
 
-   First, "consolechars" can not load big font.  But most current
-   systems use "setfont" and "setfont" can load big fonts.
+   First, "consolechars" cannot load big fonts.  Fortunately, most
+   current systems use "setfont", and "setfont" can load big fonts.
 
-   Second, the big fonts require framebuffer.  This is hardware
-   limitation.  The old 8514 videostandard had special text mode with
-   12x20 fonts but I suppose this video mode is not supported by the
-   kernel and it is unlikely that you own such video adapter anyway.
+   Second, the big fonts require the framebuffer-based console.  This
+   is a hardware interface limitation.  The old 8514 video standard
+   had a special text mode with 12x20 fonts, but I suppose this video
+   mode is not supported by the kernel, and it is unlikely that you
+   own such a video adapter anyway.
 
-   Third, the big fonts can not be used with some of the framebuffer
+   Third, the big fonts cannot be used with some of the framebuffer
    drivers.  For example on my computer if I use matroxfb then all
-   font sizes work.  However if I use vga16fb instead of matroxfb
-   then, all fonts load with no error messages but only the fonts with
+   font sizes work.  However, if I use vga16fb instead of matroxfb,
+   then all fonts load with no error messages but only the fonts with
    size 14, 16 or 32x16 are displayed correctly.
 
 
-1.4) How to enlarge the image on the screen of my laptop?
+1.4) How can I enlarge the image on my laptop display?
 
    Many laptops do not scale the screen when the resolution is less
-   than the resolution of the display.  And since the resolution of
-   the default text-mode is much lower than the resolution of the LCD
-   of the laptop (text mode: 720x400, LCD: at least 1024x768), only
-   the central part of the screen is used.
+   than the resolution of the display.  Since the resolution of the
+   default text mode is much lower than the resolution of the LCD of
+   the laptop (text mode: 720x400, LCD: at least 1024x768), only the
+   central part of the screen is used.
 
    There are two ways to fix this.  The first is to reconfigure the
-   laptop to scale the image and to use the whole screen.  For many
-   laptops there is corresponding setting in the BIOS.
+   laptop to scale the image and use the whole screen.  For many
+   laptops, there is a setting for this in the BIOS.
 
-   The second way is to use some high resolution framebufer mode in
+   The second way is to use some high-resolution framebuffer mode in
    combination with some of the large fonts of console-setup.  The
-   drawback is that the screen will be slow.
+   drawback is that console output will be slow.
 
 
-1.5) The symbols on the screen of my LCD are ugly
+1.5) Display is ugly in text mode on my LCD.
 
-   The resolution of the text-mode is much lower than the resolution
-   of your LCD and because of that your LCD has to scale the image.
-   Unfortunately many LCD do not do this job well.
+   The resolution of the default text mode is much lower than the
+   resolution of your LCD, and because of that, your LCD has to scale
+   the image.  Unfortunately, many LCDs do not do this job well.
 
-   How well your LCD will perform in text mode doesn't depend much of
-   its price but rather by the company that produced it.  Before you
-   buy an LCD you may want to check how it performs in text mode.
+   How well your LCD performs in text mode doesn't depend much on its
+   price but rather on the company that produced it.  Before you buy
+   an LCD, you may want to check how it performs in text mode.
 
-   In order to fix this problem use high resolution framebuffer mode
-   in combination with some of the large fonts of console-setup.  This
-   way you will have a slow but excellent and impressive screen.
+   In order to fix this problem, use a high-resolution framebuffer
+   mode in combination with some of the large fonts of console-setup.
+   This way, you will have a slow but crisp and impressive screen.
 
 
-1.6) I can not use my boot splash screen program or SVGATextMode!
+1.6) I cannot use my boot splash screen program or SVGATextMode!
 
-   Some programs that change the state of the console must reload the
-   console font.  If this happens after the execution of the boot
-   script of console-setup, then the font of the console-setup will be
-   overwritten.  Add a new boot script that simply executes 'setupcon'
-   (with no parameters) after these programs load their own font.
+   Some programs that change the state of the console reload the
+   console font.  If this happens after the execution of the
+   console-setup boot script, then the font loaded by console-setup
+   will be overwritten.  Add a new boot script that simply executes
+   'setupcon' (with no parameters) after these programs load their own
+   font.
 
 
-2) THE INPUT ON THE CONSOLE
+2) INPUT ON THE CONSOLE
 
 2.1) I cannot type any non-ASCII character.  How do I fix the keymap?
 
-   In most cases the keymap does not need a fix.
+   In most cases, the keymap does not need to be fixed.
 
-   Are you sure that you have correct locale?  For example if you use
-   ISO-8859-1 in Denmark, then the LANG environment variable should
-   have value "da_DK".  With some distributions you also have to set
-   the LC_ALL environment variable.
+   Are you sure that your locale is set correctly?  For example, if
+   you use ISO-8859-1 in Denmark, then the LANG environment variable
+   should be set to "da_DK".  In some setups, you also have to set the
+   LC_ALL environment variable.
 
-   Type the command 'locale charmap'.  If you see "UTF-8" then you are
-   using an Unicode locale.  Otherwise you are using an 8-bit
+   Type the command 'locale charmap'.  If you see "UTF-8", then you
+   are using a Unicode locale.  Otherwise, you are using an 8-bit
    encoding.  Now look at the setting CHARMAP in the configuration
-   file of console-setup (/etc/default/console-setup).  If you are
-   using an Unicode locale then this setting has to be CHARMAP=UTF-8.
+   file for console-setup (/etc/default/console-setup).  If you are
+   using a Unicode locale, then this setting has to be CHARMAP=UTF-8.
    Otherwise it has to be something like CHARMAP=ISO-8859-15.
 
-   Are you sure also that your command interpreter accepts non-ASCII
-   symbols?  Can you enter these characters in X in terminal emulator?
-   If not, then try to make a file ~/.inputrc with the following
-   contents:
+   Also, are you sure that your command interpreter accepts non-ASCII
+   symbols?  Can you enter these characters in X in a terminal
+   emulator?  If not, then try to make a file ~/.inputrc containing
+   the following directives:
 
       set meta-flag on
       set convert-meta off
       set output-meta on
 
 
-2.2) The layouts toggle wrong when three keyboard layouts are set!
+2.2) Toggling keyboard layouts misbehaves when three layouts are set up.
 
-   Unfortunately it is impossible to implement three-layouts toggle on
-   the console.  Because of this console-setup toggle them in the
-   following order Layout 1->Layout 2->Layout 1->Layout 3.  If you
-   want different order, then use four-layout configuration.  For
-   example if you use XKBLAYOUT=rs,rs,us,rs and XKBVARIANT=latin,,,
-   the layouts will be toggled in the following order:
+   Unfortunately, true three-layout toggle on the console is not
+   implemented.  Because of this, console-setup toggles them in the
+   following order: Layout 1->Layout 2->Layout 1->Layout 3.  If you
+   prefer a different order, then use a four-layout configuration.
+   For example, if you use XKBLAYOUT=rs,rs,us,rs and XKBVARIANT=latin,,,
+   then the layouts will be toggled in the following order:
 
        Serbian Latin -> Serbian Cyrillic -> US -> Serbian Cyrillic
 
 
-2.3) Where is the Dvorak keyboard?
+2.3) Where is the Dvorak keyboard layout?
 
    The Dvorak layouts are variants of the national layouts.  For
    example if you want to use the Norwegian variant of the Dvorak
@@ -203,23 +207,24 @@
    in /etc/default/console-setup.
 
 
-2.4) Why doesn't the Backspace key work properly?
+2.4) Why doesn't the Backspace key doesn't work properly?
 
-   When the console is in UTF-8 mode, then the Backspace doesn't work
+   If the console is in UTF-8 mode, the Backspace doesn't work
    properly for the non-ASCII symbols.  This is a bug in the kernel.
-   If you want to make getty ignore the non-ASCII symbols, then add an
+   If you want to make getty ignore the non-ASCII symbols, add an
    option -8 to it.  For example in /etc/inittab you can have a line
-   like
+   like this:
+
 	  1:2345:respawn:/sbin/getty -8 38400 tty1
 
 
-2.5) Why doesn't the CapsLock led work?
+2.5) Why doesn't the Caps Lock LED turn on?
 
-   This happens if your working encoding is UTF-8.  Unfortunately due
-   to bugs in the kernel and possibly in loadkeys also, when the
-   console is in Unicode mode, CapsLock doesn't work for the non-ASCII
-   letters.  That is why we decided to use regular modifiers instead
-   of CapsLock.  We hope the kernel developers will find a better
-   solution of this problem.
+   This happens if your working encoding is UTF-8.  Unfortunately, due
+   to bugs in the kernel and possibly in loadkeys, when the console is
+   in Unicode mode, true Caps Lock doesn't work for non-ASCII letters.
+   That is why we decided to use regular modifiers instead of
+   Caps Lock.  We hope the kernel developers will find a better
+   solution for this problem.
 
-   When the console is not in UTF-8 mode CapsLock works as it should.
+   When the console is not in UTF-8 mode, Caps Lock works as it should.

Reply to: