glfs/general/prog/python-modules/pygments.xml
2024-01-19 22:39:35 +01:00

143 lines
4.0 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../../general.ent">
%general-entities;
<!ENTITY pygments-download-http
"https://files.pythonhosted.org/packages/source/P/Pygments/pygments-&pygments-version;.tar.gz">
<!ENTITY pygments-download-ftp " ">
<!ENTITY pygments-md5sum "&pygments-md5sum;">
<!ENTITY pygments-size "4.7 MB">
<!ENTITY pygments-buildsize "52 MB">
<!ENTITY pygments-time "less than 0.1 SBU">
]>
<!-- Begin Pygments -->
<sect2 id="pygments" xreflabel="Pygments-&pygments-version;">
<title>Pygments-&pygments-version;</title>
<indexterm zone="pygments">
<primary sortas="a-Pygments">Pygments</primary>
</indexterm>
<sect3 role="package">
<title>Introduction to Pygments Module</title>
<para>
<application>Pygments</application> is a general syntax highlighter
written in <application>Python</application>, for more than 300
languages.
</para>
&lfs120_checked;
<bridgehead renderas="sect4">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&pygments-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&pygments-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &pygments-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &pygments-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &pygments-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &pygments-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Pygments Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="hatchling"/>
</para>
</sect3>
<sect3 role="installation">
<title>Installation of Pygments</title>
<para>
Build the <application>Python 3</application> module:
</para>
&build-wheel;
<para>
To install the package run the following as the &root; user:
</para>
<screen role="root"><userinput>&install-wheel; Pygments</userinput></screen>
</sect3>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../../xincludes/pip3-cmd-explain.xml"/>
<sect3 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
pygmentize
</seg>
<seg>
None
</seg>
<seg>
/usr/lib/python&python3-majorver;/site-packages/pygments and
/usr/lib/python&python3-majorver;/site-packages/Pygments-&pygments-version;.dist-info
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="pygmentize">
<term><command>pygmentize</command></term>
<listitem>
<para>
highlights an input file and writes the result to an output file
</para>
<indexterm zone="pygments pygmentize">
<primary sortas="b-pygmentize">pygmentize</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>