d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some formatting bug work-arounds.

Browse Source
This commit is contained in:
John Fieber 1996-06-26 03:28:51 +00:00
parent 8b34936102
commit 9db4d54246
1 changed files with 127 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
share/doc/handbook/ports.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id: ports.sgml,v 1.10 1996/05/16 23:18:10 mpp Exp $ -->
<!-- $Id: ports.sgml,v 1.11 1996/06/26 01:18:53 jraynard Exp $ -->
<!-- The FreeBSD Documentation Project -->
<sect><heading>The Ports collection<label id="ports"></heading>
@ -78,7 +78,7 @@ as they could be), with perhaps a configuration script.
The standard scenario is that you FTP down the tarball, extract it
somewhere, glance through the instructions, make any changes that seem
necessary, run the configure script to set things up and use the standard
'make' program to compile and install the program from the source.
`make' program to compile and install the program from the source.
<p>
FreeBSD ports still use the tarball mechanism, but use a
<ref id="ports:skeleton" name="skeleton"> to hold the &quot;knowledge&quot;
@ -143,12 +143,12 @@ this yourself, you may well have got something like this at the start:-
>> Attempting to fetch from ftp://slc2.ins.cwru.edu/pub/dist/.
</verb>
<p> The 'make' program has noticed that you didn't have a local copy
<p> The `make' program has noticed that you didn't have a local copy
of the source code and tried to FTP it down so it could get the job
done (are you starting to feel impressed? 8-)). I already had the
source handy in my example, so it didn't need to fetch it.
<p> Let's go through this and see what the 'make' program was doing.
<p> Let's go through this and see what the `make' program was doing.
<enum>
<item> Locate the source code <ref id="ports:tarball"
@ -288,7 +288,7 @@ password. Remember to use binary (aka image) mode!]
What happened here? We connected to the FTP server in the usual way
and went to its databases sub-directory. When we gave it the command
'get gnats.tar.gz', the FTP server <ref id="ports:tarball"
`get gnats.tar.gz', the FTP server <ref id="ports:tarball"
name="tarballed"> up the gnats directory for us and even went to the
trouble of compressing it before sending it so we could get our hands
on it a little quicker.
@ -362,25 +362,25 @@ post-install:
gzip -9nf ${PREFIX}/man/man1/bash.1 ${PREFIX}/man/man1/bash_builtins.1
.endif
.include <bsd.port.mk>
.include &lt;bsd.port.mk>
</verb>
The lines beginning with a &quot;#&quot; sign are comments for the benefit
of human readers (as in most Unix script files).
<p>
&quot;DISTNAME&quot; specifies the name of the <ref id="ports:tarball"
`DISTNAME&quot; specifies the name of the <ref id="ports:tarball"
name="tarball">, but without the extension.
<p>
&quot;CATEGORIES&quot; states what kind of program this is.
`CATEGORIES&quot; states what kind of program this is.
<p>
&quot;MASTER_SITES&quot; is the URL(s) of the master FTP site, which is
`MASTER_SITES&quot; is the URL(s) of the master FTP site, which is
used to retrieve the <ref id="ports:tarball" name="tarball"> if it is not
available on the local system. This is a site which is regarded as
reputable, and is normally the one from which the program is officially
distributed (in so far as any software is &quot;officially&quot; distributed
on the Internet).
<p>
&quot;MAINTAINER&quot; is the email address of the person who is
`MAINTAINER&quot; is the email address of the person who is
responsible for updating the skeleton if, for example a new version
of the program comes out. (Note: The title of &quot;maintainer&quot;
is mainly an administrative one; it does <em /not/ mean the person
@ -394,13 +394,13 @@ Skipping over the next few lines for a minute, the line
</verb>
says that the other statements and commmands
needed for this port are in a standard file called
&quot;bsd.port.mk&quot;. As these are the same for all ports, there is
`bsd.port.mk&quot;. As these are the same for all ports, there is
no point in duplicating them all over the place, so they are kept in a
single standard file.
<p>
This is probably not the place to go into a detailed examination of
how Makefiles work; suffice it to say that the lines starting with
&quot;post-install&quot; over-ride the instructions in bsd.port.mk
`post-install&quot; over-ride the instructions in bsd.port.mk
about what to do after installing the program, so that the man pages
can be compressed after they have been put in their final destination.
@ -434,7 +434,7 @@ DESCR - a more detailed description.
PLIST - a list of all the files that will be created when the program is installed.
</itemize>
<sect1><heading>It does not work?!<label id="kaput"></heading>
<sect1><heading>It does not work?!<label id="ports:kaput"></heading>
<p>Oh. You can do one of four (4) things :
@ -536,8 +536,8 @@ generated by a program of that name.
<item><label id="ports:tarball">
Q. What's all this about tarballs?
<p>
A. It's a file ending in .tar.gz (with variations like .tar.Z, or even
.tgz if you're trying to squeeze the names into a DOS filesystem).
A. It's a file ending in .tar.gz (with variations like .tar.Z, or
even .tgz if you're trying to squeeze the names into a DOS filesystem).
<p>
Basically, it's a directory tree that's been archived into a single
file (.tar) and then compressed (.gz). This technique was originally