source: general/graphlib/svgalib.xml@ 70823f8

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY SVGAlib-download-http "http://www.svgalib.org/svgalib-&SVGAlib-version;.tar.gz">
<!ENTITY SVGAlib-download-ftp " ">
<!ENTITY SVGAlib-size "827 KB">
<!ENTITY SVGAlib-buildsize "9.7 MB">
<!ENTITY SVGAlib-time "0.20 SBU">

]>

<sect1 id="SVGAlib" xreflabel="SVGAlib-&SVGAlib-version;">
<?dbhtml filename="SVGAlib.html"?>
<title>SVGAlib-&SVGAlib-version;</title>

<sect2>
<title>Introduction to <application>SVGAlib</application></title>

<para><application>SVGAlib</application> is a low-level graphics library
that provides <acronym>VGA</acronym> and <acronym>SVGA</acronym>
modes in a console. This is useful for programs running on a console
that require graphics capabilities.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink url="&SVGAlib-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&SVGAlib-download-ftp;"/></para></listitem>
<listitem><para>Download size: &SVGAlib-size;</para></listitem>
<listitem><para>Estimated Disk space required: &SVGAlib-buildsize;</para></listitem>
<listitem><para>Estimated build time: &SVGAlib-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Required Patch: <ulink 
url="&patch-root;/svgalib-&SVGAlib-version;-gcc3-1.patch"/></para></listitem>
</itemizedlist></sect3>

</sect2>

<sect2>
<title>Installation of <application>SVGAlib</application></title>

<note><para>You must compile and install as root. If you don't, certain tools
won't be able to become <acronym>SUID</acronym> root which is required for
proper operation. However, this raises a risk of exposing your system to any
holes in those tools that might be used to gain root access, so use with
caution.</para></note>

<para>Install <application>SVGAlib</application> by running the following 
commands:</para>

<screen><userinput><command>patch -Np1 -i ../svgalib-&SVGAlib-version;-gcc3-1.patch &amp;&amp;
make prefix=/usr install &amp;&amp;
cd doc &amp;&amp;
for dir in man?; do for file in $dir/*; do \
gunzip /usr/share/man/$file; done; done</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>cd doc &amp;&amp; for dir in man?; do for file in $dir/*; do
gunzip /usr/share/man/$file; done; done</command>:
<application>SVGAlib</application> installs its man pages in compressed format
so we uncompress them.</para>

</sect2>

<sect2>
<title>Configuring SVGAlib</title>

<sect3><title>Config files</title>

<para><filename>/etc/vga/libvga.config</filename>, 
<filename>~/.svgalibrc</filename></para>
</sect3>

<sect3><title>Configuration information</title>

<para>You must edit the config file to set the monitor and mouse type.
Depending on your hardware, other setup might be required.</para>

<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../../lib-config.xml"/>

</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The SVGAlib package contains <filename class="libraryfile">libvga</filename>
and <filename class="libraryfile">libvgagl</filename> libraries,
<command>dumpreg</command>, <command>mode3</command>, <command>restorefont</command>,
<command>restorepalette</command>, <command>restoretextmode</command>,
<command>savetextmode</command>, <command>textmode</command> and
<command>svgakeymap</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>libvga library</title>
<para><filename class="libraryfile">libvga</filename> is a low-level
graphics library.</para></sect3>

<sect3><title>libvgagl library</title>
<para><filename class="libraryfile">libvgagl</filename> is a fast
frame buffer level graphics library based on libvga.</para></sect3>

<sect3><title>dumpreg</title>
<para><command>dumpreg</command> dumps the state of the card as the
svgalib chipset driver sees it.</para></sect3>

<sect3><title>mode3</title>
<para><command>mode3</command> sets a <acronym>VESA</acronym> mode.</para></sect3>

<sect3><title>restorefont</title>
<para><command>restorefont</command> saves or restores the
<acronym>SVGA</acronym> font for textmode.</para></sect3>

<sect3><title>restorepalette</title>
<para><command>restorepalette</command> sets the color palette for
textmode.</para></sect3>

<sect3><title>restoretextmode</title>
<para><command>restoretextmode</command> saves or restores the
<acronym>SVGA</acronym> registers for textmode.</para></sect3>

<sect3><title>savetextmode, textmode</title>
<para><command>savetextmode</command> and <command>textmode</command> save or
restore the complete <acronym>SVGA</acronym> status for textmode.</para></sect3>

<sect3><title>svgakeymap</title>
<para><command>svgakeymap</command> generates keymaps for svgalib.</para></sect3>

</sect2>

</sect1>