source: postlfs/editors/ed.xml@ 0590c1b6

<?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 ed-download-http "http://ftp.gnu.org/pub/gnu/ed/ed-&ed-version;.tar.gz">
  <!ENTITY ed-download-ftp  "ftp://ftp.gnu.org/pub/gnu/ed/ed-&ed-version;.tar.gz">
  <!ENTITY ed-size          "182 KB">
  <!ENTITY ed-buildsize     "3.1 MB">
  <!ENTITY ed-time          "0.10 SBU">
]>

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

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

<para><application>Ed</application> is a line-oriented text editor. It
is used to create, display, modify and otherwise manipulate text files,
both interactively and via shell scripts. Ed isn't something which many
people use. It's described here because it can be used by the patch
program if you encounter an ed-based patch file. This happens rarely
because diff-based patches are preferred these days.</para>

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

<sect3><title>Additional downloads</title>
<itemizedlist spacing="compact">
<listitem><para>Required Patch: <ulink
url="&patch-root;/ed-&ed-version;-mkstemp.patch"/></para></listitem>
</itemizedlist></sect3>

</sect2>

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

<para><application>Ed</application> normally uses the
<emphasis>mktemp</emphasis> function to create temporary files in
<filename class="directory">/tmp</filename>, but this function contains
a vulnerability (see the section on Temporary Files at
<ulink url="http://en.tldp.org/HOWTO/Secure-Programs-HOWTO/avoid-race.html"/>).
Apply the following patch to make <application>Ed</application> use
<emphasis>mkstemp</emphasis> instead, a secure way to create temporary
files:</para>

<screen><userinput><command>patch -Np1 -i ../ed-&ed-version;-mkstemp.patch</command></userinput></screen>

<para>Now prepare <application>Ed</application> for compilation:</para>

<screen><userinput><command>./configure --prefix=/usr --exec-prefix=""</command></userinput></screen>

<para>Compile the package:</para>

<screen><userinput><command>make</command></userinput></screen>

<para>To test the results, issue: <command>make check</command>.</para> 

<para>Install the package:</para>

<screen><userinput><command>make install</command></userinput></screen>

</sect2>

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

<para><parameter>--exec-prefix=""</parameter>: This forces the programs
to be installed into the <filename class="directory">/bin</filename>
directory. Having the programs available there is useful in the event of
the <filename class="directory">/usr</filename> partition being
unavailable.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Ed</application> package contains
<command>ed</command> and
<command>red</command> (link to <command>ed</command>).</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>ed</title>
<para><command>ed</command>
is a line-oriented text editor.
</para></sect3>

<sect3><title>red</title>
<para><command>red</command>
is a restricted ed&mdash;it can only edit files in the current directory
and cannot execute shell commands.
</para></sect3>

</sect2>

</sect1>