diff options
Diffstat (limited to 'demo/neatstart.ms')
| -rw-r--r-- | demo/neatstart.ms | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/demo/neatstart.ms b/demo/neatstart.ms index 6ee4324..f1e33e1 100644 --- a/demo/neatstart.ms +++ b/demo/neatstart.ms @@ -17,11 +17,11 @@ \fIA. G. Rudi\fP .sp 3 The present document explains the steps necessary for setting up and -using Neatroff. It uses neatroff_make Git repository, which contains +using Neatroff. It uses the neatroff_make Git repository, which contains a set of standard macro packages and a top-level Makefile to obtain and build Neatroff and its helper programs, which are referred to as Neat* throughout this document. More details about Neatroff and the -programs that accompany it are available in its homepage at +programs that accompany it are available at its homepage \*[post.url http://litcave.rudi.ir/]. .SH "Using Neatroff Without Installation" @@ -48,14 +48,14 @@ $ cd demo && make .cc.end .LP -To compile Neatroff documents outside neatroff_make/demo, the Makefile -in this directory is a good template. Copy this Makefile to that -directory and modify its \s-1BASE\s+1 macro to point to neatroff_make/ +To compile Neatroff documents outside of neatroff_make/demo, the Makefile +in this directory serves as a good template. Copy it to +your document directory and modify its \s-1BASE\s+1 macro to point to the neatroff_make/ directory. To add new fonts, simply place them in the fonts/ subdirectory and re-make the \(lqneat\(rq target. To use the new font in Neatroff, the -file name without its extension may be mounted. For instance, if the +file name without its extension must be mounted. For instance, if the name of the font is NewFont.ttf, the following Troff code mounts and uses this font. @@ -67,20 +67,20 @@ Text in NewFont .SH "Installing Neatroff" This section describes how to install Neatroff in system directories. -First modify \s-1BASE\s+1 macro in neatroff_make/Makefile to point to +First modify the \s-1BASE\s+1 macro in neatroff_make/Makefile to point to the installation location. Then, after compilining Neatroff as -described in the previous section, build Makefile's install target. +described in the previous section, build the Makefile's install target. .cc.beg $ make install .cc.end .LP -Note that this command may need to be executed by a superuser +Note that this command may need to be executed by the superuser, depending on the directory specified as \s-1BASE\s+1. At this point Neat* should be installed. As described in the previous section, the -Makefile in demo/ subdirectory is a good template for compiling -Neatroff documents. You need to update its value of \s-1BASE\s+1 +Makefile in the demo/ subdirectory is a good template for compiling +Neatroff documents. You need to update its value of the \s-1BASE\s+1 macro. .LP @@ -94,30 +94,30 @@ Neatroff's font descriptions can be generated with the Neatmkfn program as follows (BASE is Neatroff's installation directory): .LP .cc.beg -$ mkfn -b -a <fontpath.afm >$BASE/devutf/fontname -$ mkfn -b -o <fontpath.ttf >$BASE/devutf/fontname +$ neatmkfn -b -a <fontpath.afm >$BASE/devutf/fontname +$ neatmkfn -b -o <fontpath.ttf >$BASE/devutf/fontname .cc.end .LP -After generating font description, the new font can be mounted in -troff just as other fonts with \&.fp request: +After generating the font description, the new font can be mounted in +troff just as other fonts with the \&.fp request: .cc.beg \&.fp 12 F2 fontname .cc.end .LP -Alternatively, you can place your fonts in neatroff_make/fonts/ +Alternatively, you can place your fonts in the neatroff_make/fonts/ directory before running make neat; the neat Makefile target generates and installs font descriptions for all fonts in that directory -automatically. This is specially convenient when the number of fonts +automatically. This is especially convenient when the number of fonts is large. There is another method of using fonts in Neatroff that creates the font descriptions on the fly. Despite its overhead, this method may be convenient when testing new fonts. It uses the fp macro package, -which is included in neatroff_make (-mfp should be passed to -Neatroff). First, the value of fp.src string register should specify +which is included in neatroff_make \%(-mfp should be passed to +Neatroff). First, the value of the fp.src string register should specify the directory containing new fonts. The package defines \&.fp.ttf, \&.fp.otf, and \&.fp.afm macros, whose behaviour is quite similar to the standard \&.fp request, except that @@ -128,7 +128,7 @@ test.tr can contain: .cc.beg \&.ds fp.src "/path/\:to/\:fonts/ \&.fp.ttf - F3 NewFont -\&.ft FN +\&.ft F3 Testing the new font... .cc.end |