Algo de documentación

Esta página está dividida en varias secciones. Use el menú flotante de la derecha para navegar en ella.

Código fuente

El código fuente actualmente está en Git. Para obtenerlo, es necesario contar con una correcta instalación de Git. Después, use:

git clone git://superkb.git.sourceforge.net/gitroot/superkb superkb-git

También, el código tiene muchos FIXME ("arréglame") and necesitan trabajo. Están documentados a lo largo del código.

Compilación

Un simple make debe bastar. Sin embargo, en algunas sdistribuciones es necesario aplicarlo dos veces.

Superkb usa un archivo llamado "configuration" para registrar las cualidades actuales del sistema. Este archivo acepta las siguientes directivas:

• PUTICON_GDKPIXBUF={y|m|n}: indica si se debe compilar el soporte para Gdk-Pixbuf (y), incluirlo como módulo (m) o no incluirlo de plano (n). Normalmente lo detecta Makefile mediante pkg-config gdk-pixbuf-xlib-2.0.
• PUTICON_IMLIB2={y|m|n}: indica si se debe compilar el soporte para Imlib2 (y), incluirlo como módulo (m) o no incluirlo de plano (n). Normalmente lo detecta Makefile mediante imlib2-config.

Instalación

Un simple make install debe bastar. Las rutas de instalación son fijas en este momento.

Configuración

Superkb busca un archivo llamado .superkbrc en el directorio $HOME. El archivo es interpretado como un script, por lo que si dos líneas se contradicen, gana la segunda en orden de aparición. Se pueden indicar comentarios mediante el signo de número (#) y se ignora el resto de la lí­nea. La sintaxis básica es "CLAVE valor", pero si el valor incluye espacios, se debe envolver en comillas ("). Las directivas que se admiten son:

• IMAGELIB {gdkpixbuf|imbli2}: Establece la librerí­a para cargar iconos. Se debe incluir soporte ya sea compilado o como módulo. Vea Compilación para mayor información. Valor por omisión: "imlib2".
• FONT "fuente": El nombre XLFD de la fuente a usar. Recomiendo usar una fuente escalable. Yo uso xfontsel -pattern "*-0-0-0-0-*-0-*" para cargar un selector de fuentes apropiadas. Sin embargo, algunas personas han indicado que esto no necesariamente funciona. No olvide las comillas en el nombre de la fuente, ya que algunas incluyen espacios. Valor por omisión: "-*-bitstream vera sans-bold-r-*-*-*-*-*-*-*-*-*-*".
• BACKGROUND r v a: Marca el color de fondo a usar. Cada valor debe estar entre 0 y 65535. Muy probablemente esto cambiará en un futuro. Valor por omisión: 59500 59500 59500. (Sí, está feo.)
• FOREGROUND r v a: Marca el color de primer plano a usar. Cada valor debe estar entre 0 y 65535. Muy probablemente esto cambiará en un futuro. Valor por omisión: 2000 2000 2000. (Je, también está feo.)
• DELAY segundos: Marca el tiempo a esperar a mostrar el teclado después de que se mantiene la tecla de Super presionada. Se admiten valores decimales. Valor por omisión: 0.5.
• SUPERKEY1_STRING: Establece la primera tecla Super, por nombre. Valor por omisión: "Super_L"
• SUPERKEY2_STRING: Establece la segunda tecla Super, por nombre. Valor por omisión: "Super_R"
• SUPERKEY1_CODE: Establece la primera tecla Super, por código de tecla de X.
• SUPERKEY1_STRING: Establece la segunda tecla Super, por por código de tecla de X.
• KEY COMMAND tecla máscara comando icono [retro]: Ejecuta un comando arbitrario. "Tecla" indica la tecla a usar. No todas las teclas funcionan, en este momento, pero sí las letras y las de función (como "F1"). "Máscara" está reservado para uso futuro; sólo hay que poner un 0. "Comando" es el comando a ejecutar (no olvidar poner las comillas si se necesita) e "Icono" es la ubicación ABSOLUTA del archivo con el icono a mostrar en el teclado. La cadena opcional "retro" debe aparecer con la línea a añadir al FEEDBACK_HANDLER. Por ejemplo, si el FEEDBACK_HANDLER es 'xmessage -timeout 2 -center Cargando ', la cadena "retro" debe ser algo como "gedit", para que muestre "Cargando gedit" en pantalla. Nótese que omitir la cadena "retro" deshabilita la retroalimentación para esa KEY.
• KEY DOCUMENT tecla máscara documento icono [retro]: Usa DOCUMENT_HANDLER para abrir el documento especificado "Tecla" indica la tecla a usar. No todas las teclas funcionan, en este momento, pero sí las letras y las de función (como "F1"). "Máscara" está reservado para uso futuro; sólo hay que poner un 0. "Comando" es el comando a ejecutar (no olvidar poner las comillas si se necesita) e "Icono" es la ubicación ABSOLUTA del archivo con el icono a mostrar en el teclado. La cadena opcional "retro" debe aparecer con la línea a añadir al FEEDBACK_HANDLER. Por ejemplo, si el FEEDBACK_HANDLER es 'xmessage -timeout 2 -center Cargando ', la cadena "retro" debe ser algo como "gedit", para que muestre "Cargando gedit" en pantalla. Nótese que omitir la cadena "retro" deshabilita la retroalimentación para esa KEY.
• DOCUMENT_HANDLER cadena: Indica el programa a usar para abrir los documentos indicados por una KEY DOCUMENT.
• FEEDBACK_HANDLER cadena: Indica el programa a usar para mandar el feedback cuando se ejecuta una KEY. Técnicamente hablando, el comando se compone del parámetro "retro" en el comando KEY, añadido al parámetro indicado en FEEDBACK_HANDLER.
• SUPERKEY_REPLAY { 0 | 1 }: Indica si la tecla Super debe ser reenviada a la pantalla de la cual fue robada, de modo que no se pierda el uso convencional de la tecla. Por ejemplo, si se usa F10 como tecla Super, esta opción permite que si la tecla se presiona sin combinarse con otra ni permitir que el teclado aparezca en pantalla (estilo click), se reenvíe ese F10 a la aplicación original, de modo que en GNOME, se presentaría el menú en las aplicaciones que tienen uno.

Probando en distibuciones

Estas son notas de instalación e instrucciones para distros específicas. Se aceptan comentarios y adiciones.

Ubuntu 6.06 LTS (Dapper Drake)

• Prepare su instalación de Ubuntu:
  • Corra Synaptic Package Manager, de Sistema > Administración
  • Presione Reload
  • Marque "make", "libimlib2-dev" y "gcc" (no -4.0, no -3.x, sino "gcc" simple).
  • Presione Aplicar y continúe como siempre.
• Actualice libimlib2. (Al momento de elaborar este documento, Ubuntu no incluye la versión necesaria, ni siquiera como actualización:
  • wget http://easynews.dl.sourceforge.net/sourceforge/enlightenment/imlib2-1.2.2.tar.gz
  • tar xvzf imlib2-1.2.2.tar.gz
  • cd imlib2-1.2.2
  • ./configure --prefix=/usr && make
  • sudo make install
• Instale Superkb:
  • Descargue Superkb de la sección Descargas.
  • tar xvzf superkb-0.10-tar.gz —o— tar xvjf superkb-0.10.tar.bz2
  • cd superkb-0.10
  • sudo make install
• Configure Superkb:
  • cp sample-config/superkbrc-gnome $HOME/.superkbrc
  • Edite $HOME/.superkbrc con gedit o cualquier otro editor de textos:
    • Cambie la primera línea ("IMAGELIB gdkpixbuf") a "IMAGELIB imlib2"
    • Tal vez necesite establecer la fuente. Vea arriba, en la sección de documentación sobre la directiva FONT para mayor información.
    • Guarde y salga.
• Corra el programa mediante el comando "superkb".
• Quizá quiera incluirlo en la lista de programas de arranque, añadiéndolo en Sistema > Preferencias > Sesiones > Programas de Arranque.

Yo tengo Superkb corriendo en Ubuntu 6.06 LTS en mi estación de trabajo.

Hay algunos problemas al correr Superkb en Ubuntu en una IBM Thinkpad T42. La laptop no incluye una tecla Win, y la que deseo usar (Avanzar) manda KeyPress y KeyRelease simultáneamente, independientemente de su estado AutoRepeat. Esto impide su uso en Superkb, en Ubuntu 6.10 LTS.

Arch Linux 0.7

Tengo Superkb corriendo en mi Arch Linux 0.7, en la Thinkpad.

Ubuntu 6.10 (Edgy Eft)

Antes de instalar Superkb, debes actualizar tu X.org, pues tiene un bug. Hay paquetes precompilados para i386 para Ubuntu Edgy disponibles, así que sólo debe ser cosa de instalarlos con dpkg. Esto es lo que funcionó conmigo:

1. Ejecuta en una terminal: dpkg -l | grep ^ii | grep -E "xdmx-tools|xdmx|xnest|xserver-xephyr|xserver-xorg-core|xserver-xorg-dev|xvfb". Estos son los paquetes que necesitas actualizar, así que:
2. Bájalos de http://people.ubuntu.com/~seb128/xorg-server-edgy-update/.
3. Ejecuta sudo dpkg -i package-name.deb en cada archivo bajado.
4. Reinicia tu X.org.

Ahora que está reparado el X.org de Edgy, sigue las instrucciones para Ubuntu 6.06 LTS (Dapper Drake).

Fedora Core 6

Debido a una falla en el Xorg incluida en Fedora Core 6, Superkb no funciona. Esto fue reparado en Xorg poco después de la liberación de Fedora Core 6. No tengo información sobre actualizaciones que reparen esta falla en la distribución.

Fedora Core 5

• Prepare su configuración de Fedora Core 5:
  • Abra una ventana de terminal.
  • yum install imlib2-devel xorg-x11-devel gcc
• Actualice libimlib2. (Al momento de elaborar este documento, Ubuntu no incluye la versión necesaria, ni siquiera como actualización:
• wget http://easynews.dl.sourceforge.net/sourceforge/enlightenment/imlib2-1.2.2.tar.gz
• tar xvzf imlib2-1.2.2.tar.gz
• cd imlib2-1.2.2
• ./configure --prefix=/usr && make
• su -c "make install"

InstaleSuperkb:

• Descargue Superkb de la sección Descargas.
• tar xvzf superkb-0.10-tar.gz —o— tar xvjf superkb-0.10.tar.bz2
• cd superkb-0.10
• su -c "make install"

Configure Superkb:

• cp sample-config/superkbrc-gnome $HOME/.superkbrc
• Edit $HOME/.superkbrc with gedit or any other text-editor:
  • Cambie la primera línea ("IMAGELIB gdkpixbuf") a "IMAGELIB imlib2"
  • Tal vez necesite establecer la fuente. Vea arriba, en la sección de documentación sobre la directiva FONT para mayor información.
  • Guarde y salga.

Ejecute Superkb mediante "superkb".

Debian Sid

Debido a una falla en el Xorg incluida en Debian Sid, Superkb no funciona. Esto fue reparado en Xorg poco después de la liberación de Debian Sid. No tengo información sobre actualizaciones que reparen esta falla en la distribución.