From owner-freebsd-doc Tue Jan 1 2:53:25 2002 Delivered-To: freebsd-doc@freebsd.org Received: from straylight.ringlet.net (discworld.nanolink.com [217.75.135.248]) by hub.freebsd.org (Postfix) with SMTP id 455BE37B41A for ; Tue, 1 Jan 2002 02:53:07 -0800 (PST) Received: (qmail 3603 invoked by uid 1000); 1 Jan 2002 10:51:52 -0000 Date: Tue, 1 Jan 2002 12:51:51 +0200 From: Peter Pentchev To: doc@FreeBSD.org Subject: Re: -> Message-ID: <20020101125151.A1609@straylight.oblivion.bg> Mail-Followup-To: doc@FreeBSD.org References: <20011231100926.A3512@straylight.oblivion.bg> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <20011231100926.A3512@straylight.oblivion.bg>; from roam@ringlet.net on Mon, Dec 31, 2001 at 10:09:26AM +0200 Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org On Mon, Dec 31, 2001 at 10:09:26AM +0200, Peter Pentchev wrote: > Hi, > > Is there a reason to use instead of when referring > to a port? If not, how about the attached patch? > > There are still a couple of 's with port directories left > in the doc tree, but they are there for legitimate reasons - e.g. > the Porter's Handbook talks about directories, not ports, in several > places, so should be more appropriate. OK, here's a second version of the patch - there were a couple that I missed at the first run. G'luck, Peter -- This sentence is false. Index: doc/en_US.ISO8859-1/books/faq/book.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/faq/book.sgml,v retrieving revision 1.339 diff -u -r1.339 book.sgml --- doc/en_US.ISO8859-1/books/faq/book.sgml 24 Dec 2001 10:47:09 -0000 1.339 +++ doc/en_US.ISO8859-1/books/faq/book.sgml 1 Jan 2002 10:35:28 -0000 @@ -847,7 +847,7 @@ The Zip format. If you want to uncompress this on FreeBSD you will need to install the - archivers/unzip port + archivers/unzip port first. @@ -864,7 +864,7 @@ The BZip2 format. Less widespread than the others, but generally gives smaller files. - Install the archivers/bzip2 + Install the archivers/bzip2 port to uncompress these files. @@ -3288,9 +3288,9 @@ FreeBSD supports many software modems via add-on - software. The comms/ltmdm port adds + software. The comms/ltmdm port adds support for modems based on the very popular Lucent LT - chipset. The comms/mwavem port + chipset. The comms/mwavem port supports the modem in IBM Thinkpad 600 and 700 laptops. @@ -3715,7 +3715,7 @@ special hook has been added into the CD9660 driver to allow the user to load an appropriate conversion table on the fly. Modules for some of the common encodings are available via the - sysutils/cd9660_unicode port. + sysutils/cd9660_unicode port. @@ -3782,7 +3782,7 @@ mount only works on filesystems. Audio CDs do not have filesystems; they just have data. You need a program that reads audio CDs, such as the - audio/xmcd port. + audio/xmcd port. Index: doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml,v retrieving revision 1.6 diff -u -r1.6 appendix.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml 2 Oct 2001 05:28:55 -0000 1.6 +++ doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml 30 Dec 2001 11:23:55 -0000 @@ -153,7 +153,7 @@ Producing formatted output This section assumes that you have installed the software listed in - the textproc/docproj port, either by hand, or by + the textproc/docproj port, either by hand, or by using the port. Further, it is assumed that your software is installed in subdirectories under /usr/local/, and the directory where binaries have been installed is in your Index: doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v retrieving revision 1.11 diff -u -r1.11 chapter.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml 23 Oct 2001 21:54:17 -0000 1.11 +++ doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml 30 Dec 2001 11:24:38 -0000 @@ -176,7 +176,7 @@ - Install the textproc/docproj + Install the textproc/docproj meta-port. &prompt.root; cd /usr/ports/textproc/docproj Index: doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v retrieving revision 1.37 diff -u -r1.37 chapter.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml 8 Dec 2001 12:12:46 -0000 1.37 +++ doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml 30 Dec 2001 11:25:54 -0000 @@ -80,8 +80,8 @@ loose variants). The HTML DTDs are available from the ports collection in the - textproc/html port. They are automatically - installed as part of the textproc/docproj + textproc/html port. They are automatically + installed as part of the textproc/docproj port. @@ -677,8 +677,8 @@ The DocBook DTD is available from the ports collection in the - textproc/docbook port. It is automatically - installed as part of the textproc/docproj + textproc/docbook port. It is automatically + installed as part of the textproc/docproj port. @@ -2231,12 +2231,12 @@ change, but that is not guaranteed. You will also need to install the - graphics/ImageMagick port, which is used to + graphics/ImageMagick port, which is used to convert between the different image formats. This is a big port, and most of it is not required. However, while we are working on the Makefiles and other infrastructure it makes things easier. This port is not in the - textproc/docproj meta port, you must install it + textproc/docproj meta port, you must install it by hand. The best example of what follows in practice is the Index: doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml,v retrieving revision 1.24 diff -u -r1.24 chapter.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml 8 Dec 2001 12:12:46 -0000 1.24 +++ doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml 30 Dec 2001 11:27:45 -0000 @@ -332,7 +332,7 @@ - Download and install textproc/docproj + Download and install textproc/docproj from the FreeBSD ports system. This is a meta-port that should download and install all of the programs and supporting files that are used by the @@ -396,7 +396,7 @@ Try and validate this file using an SGML parser. - Part of textproc/docproj is the + Part of textproc/docproj is the &man.nsgmls.1; validating parser. Normally, &man.nsgmls.1; reads in a document marked up according to an SGML DTD and returns a copy of the @@ -699,7 +699,7 @@ Look at the contents of /usr/local/share/sgml/html/catalog. This is the catalog file for the HTML DTDs that will have been installed as - part of the textproc/docproj port. + part of the textproc/docproj port. Index: doc/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml,v retrieving revision 1.6 diff -u -r1.6 chapter.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml 11 Nov 2001 21:30:04 -0000 1.6 +++ doc/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml 1 Jan 2002 10:36:28 -0000 @@ -48,7 +48,7 @@ Norm Walsh's modular DocBook stylesheets. These can be found in - textproc/dsssl-docbook-modular. + textproc/dsssl-docbook-modular. The modified stylesheets are not in the ports system. Instead they are part of the Documentation Project source repository, and can be Index: doc/en_US.ISO8859-1/books/fdp-primer/tools/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/tools/chapter.sgml,v retrieving revision 1.15 diff -u -r1.15 chapter.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/tools/chapter.sgml 31 Oct 2001 23:47:32 -0000 1.15 +++ doc/en_US.ISO8859-1/books/fdp-primer/tools/chapter.sgml 30 Dec 2001 11:31:17 -0000 @@ -47,10 +47,10 @@ tools is covered in later chapters. - Use <filename>textproc/docproj</filename> if possible + Use <port>textproc/docproj</port> if possible You can save yourself a lot of time if you install the - textproc/docproj port. This is a + textproc/docproj port. This is a meta-port which does not contain any software itself. Instead, it depends on various other ports being installed correctly. Installing this port should @@ -84,12 +84,12 @@ These programs are required before you can usefully work with the FreeBSD documentation, and they will allow you to convert the documentation to HTML, plain text, and RTF formats. They are all - included in textproc/docproj. + included in textproc/docproj. SP - (textproc/sp) + (textproc/sp) A suite of applications, including a validating SGML parser, @@ -99,7 +99,7 @@ Jade - (textproc/jade) + (textproc/jade) A DSSSL implementation. Used for converting marked up @@ -109,7 +109,7 @@ Tidy - (www/tidy) + (www/tidy) An HTML 'pretty printer', used to reformat some of the @@ -120,7 +120,7 @@ Links - (www/links) + (www/links) A text-mode WWW browser, &man.links.1; can also convert @@ -130,7 +130,7 @@ peps - (graphics/peps) + (graphics/peps) Some of the documentation includes images, some of which are @@ -149,7 +149,7 @@ - HTML DTD (textproc/html) + HTML DTD (textproc/html) HTML is the markup language of choice for the World Wide @@ -158,7 +158,7 @@ - DocBook DTD (textproc/docbook) + DocBook DTD (textproc/docbook) DocBook is designed for marking up technical documentation. @@ -168,7 +168,7 @@ ISO 8879 entities - (textproc/iso8879) + (textproc/iso8879) 19 of the ISO 8879:1986 character entity sets used by many @@ -189,7 +189,7 @@ Modular DocBook Stylesheets - (textproc/dsssl-docbook-modular) + (textproc/dsssl-docbook-modular) The Modular DocBook Stylesheets are used when converting @@ -216,8 +216,8 @@ JadeTeX and teTeX - (print/jadetex and - print/teTeX) + (print/jadetex and + print/teTeX) Jade and @@ -249,8 +249,8 @@ Emacs or xemacs - (editors/emacs or - editors/xemacs) + (editors/emacs or + editors/xemacs) Both these editors include a special mode for editing Index: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v retrieving revision 1.13 diff -u -r1.13 chapter.sgml --- doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml 8 Dec 2001 12:12:47 -0000 1.13 +++ doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml 30 Dec 2001 11:32:02 -0000 @@ -371,7 +371,7 @@ entity, and a semi-colon (;). The entity names are defined in ISO8879, which is in the ports - tree as textproc/iso8879. + tree as textproc/iso8879. A few examples include Index: doc/en_US.ISO8859-1/books/porters-handbook/book.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v retrieving revision 1.188 diff -u -r1.188 book.sgml --- doc/en_US.ISO8859-1/books/porters-handbook/book.sgml 18 Dec 2001 13:18:37 -0000 1.188 +++ doc/en_US.ISO8859-1/books/porters-handbook/book.sgml 1 Jan 2002 10:37:45 -0000 @@ -1593,7 +1593,7 @@ @${FALSE} .endif - japanese/xdvi300 also has all the regular + japanese/xdvi300 also has all the regular patches, package files, etc. If you type make there, it will take the default value for the resolution (300) and build the port normally. @@ -1736,7 +1736,7 @@ There are many programs that require a Motif library (available from several commercial vendors, while there is a free clone reported to be able to run many applications in - x11-toolkits/lesstif) to compile. Since it is a + x11-toolkits/lesstif) to compile. Since it is a popular toolkit and their licenses usually permit redistribution of statically linked binaries, we have made special provisions for handling ports that require Motif in a way that we can easily compile @@ -1832,7 +1832,7 @@ Here's a seven-step procedure to convert ports to use install-info. - editors/emacs will be used as an + editors/emacs will be used as an example. @@ -1884,7 +1884,7 @@ to use the extra arguments to install-info because makeinfo cannot handle those texinfo sources. (See Makefile and - pkg-plist of japanese/skk + pkg-plist of japanese/skk for examples on how to do this). @@ -3532,12 +3532,12 @@ If your port requires a certain user to be on the installed system, let the pkg-install script call pw to create it automatically. Look at - net/cvsup-mirror for an example. + net/cvsup-mirror for an example. If your port must use the same user/group ID number when it is installed as a binary package as when it was compiled, then you must choose a free UID from 50 to 999 and register it below. Look at - japanese/Wnn for an example. + japanese/Wnn for an example. Make sure you do not use a UID already used by the system or other ports. This is the current list of UIDs between 50 and To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message