Whitespace, punctuation, section header fixes, sort sections.
This commit is contained in:
parent
c0de7313ab
commit
fc7396be3d
|
@ -1,4 +1,4 @@
|
|||
.\" $NetBSD: crunchgen.1,v 1.12 2001/10/04 04:17:04 jmc Exp $
|
||||
.\" $NetBSD: crunchgen.1,v 1.13 2001/10/04 11:20:39 wiz Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1994 University of Maryland
|
||||
.\" All Rights Reserved.
|
||||
|
@ -64,7 +64,7 @@ reads in the specifications in
|
|||
.Ar conf-file
|
||||
for a crunched binary, and generates a Makefile and accompanying
|
||||
top-level C source file that when built create the crunched executable
|
||||
file from the component programs. For each component program,
|
||||
file from the component programs. For each component program,
|
||||
.Nm
|
||||
can optionally attempt to determine the object (.o) files that make up
|
||||
the program from its source directory Makefile. This information is
|
||||
|
@ -96,7 +96,7 @@ Set crunched binary executable file name to
|
|||
.Ar exec-file-name .
|
||||
The default name is ``<conf-name>''.
|
||||
.It Fl d Ar build-options
|
||||
Set the DBG variable in the generated makefile to
|
||||
Set the DBG variable in the generated makefile to
|
||||
.Ar build-options .
|
||||
The default flags are -Os.
|
||||
.It Fl f
|
||||
|
@ -119,7 +119,7 @@ Try to obtain libraries from
|
|||
.El
|
||||
.Sh CRUNCHGEN CONFIGURATION FILE COMMANDS
|
||||
.Nm
|
||||
reads specifications from the
|
||||
reads specifications from the
|
||||
.Ar conf-file
|
||||
that describe the components of the crunched binary. In its simplest
|
||||
use, the component program names are merely listed along with the
|
||||
|
@ -127,7 +127,7 @@ top-level source directories in which their sources can be found.
|
|||
.Nm
|
||||
then calculates (via the source makefiles) and caches the
|
||||
list of object files and their locations. For more specialized
|
||||
situations, the user can specify by hand all the parameters that
|
||||
situations, the user can specify by hand all the parameters that
|
||||
.Nm
|
||||
needs.
|
||||
.Pp
|
||||
|
@ -139,7 +139,7 @@ commands are as follows:
|
|||
A list of source trees in which the source directories of the
|
||||
component programs can be found. These dirs are searched using the
|
||||
.Bx
|
||||
``<source-dir>/<progname>/'' convention. Multiple
|
||||
``<source-dir>/<progname>/'' convention. Multiple
|
||||
.Em srcdirs
|
||||
lines can be specified. The directories are searched in the order
|
||||
they are given.
|
||||
|
@ -158,13 +158,13 @@ Causes the crunched binary to invoke
|
|||
whenever
|
||||
.Ar linkname
|
||||
appears in argv[0]. This allows programs that change their behavior when
|
||||
run under different names to operate correctly.
|
||||
run under different names to operate correctly.
|
||||
.El
|
||||
.Pp
|
||||
To handle specialized situations, such as when the source is not
|
||||
available or not built via a conventional Makefile, the following
|
||||
.Em special
|
||||
commands can be used to set
|
||||
commands can be used to set
|
||||
.Nm
|
||||
parameters for a component program.
|
||||
.Bl -tag -width indent
|
||||
|
@ -182,19 +182,19 @@ This is normally calculated by looking for a directory named
|
|||
.Dq Pa obj
|
||||
under the
|
||||
.Ar srcdir ,
|
||||
and if that is not found, the
|
||||
and if that is not found, the
|
||||
.Ar srcdir
|
||||
itself becomes the
|
||||
.Ar objdir .
|
||||
.br
|
||||
.Nm Note:
|
||||
This option only takes effect if the -o option to use existing object files is also
|
||||
.br
|
||||
.Nm Note :
|
||||
This option only takes effect if the -o option to use existing object files is also
|
||||
specified.
|
||||
.It Nm special Ar progname Nm objs Ar object-file-name ...
|
||||
Set the list of object files for program
|
||||
.Ar progname .
|
||||
This is normally calculated by constructing a temporary makefile that includes
|
||||
.Dq Nm srcdir / Pa Makefile
|
||||
.Dq Nm srcdir / Pa Makefile
|
||||
and outputs the value of $(OBJS).
|
||||
.It Nm special Ar progname Nm objpaths Ar full-pathname-to-object-file ...
|
||||
Sets the pathnames of the object files for program
|
||||
|
@ -206,7 +206,7 @@ pathname to each file in the
|
|||
list.
|
||||
.El
|
||||
.Pp
|
||||
Only the
|
||||
Only the
|
||||
.Em objpaths
|
||||
parameter is actually needed by
|
||||
.Nm
|
||||
|
@ -216,7 +216,7 @@ and
|
|||
.Em objs ,
|
||||
which are in turn calculated from
|
||||
.Em srcdir ,
|
||||
so is sometimes convenient to specify the earlier parameters and let
|
||||
so is sometimes convenient to specify the earlier parameters and let
|
||||
.Nm
|
||||
calculate forward from there if it can.
|
||||
.Pp
|
||||
|
@ -230,7 +230,7 @@ running make inside that program's source directory. For this to work the
|
|||
and
|
||||
.Em objs
|
||||
parameters must also be valid. If they are not valid for a particular program, that
|
||||
program is skipped in the
|
||||
program is skipped in the
|
||||
.Ar objs
|
||||
target.
|
||||
.Sh ENVIRONMENT
|
||||
|
@ -240,20 +240,20 @@ If the environment variable
|
|||
.Ev MAKEOBJDIRPREFIX
|
||||
is set, the object directory will be prefixed with the path contained in this
|
||||
environment variable.
|
||||
.br
|
||||
.Nm Note:
|
||||
This variable is only used if the -o option to use existing object files is also
|
||||
.br
|
||||
.Nm Note :
|
||||
This variable is only used if the -o option to use existing object files is also
|
||||
specified.
|
||||
.It Ev MACHINE
|
||||
If the environment variable
|
||||
.Ev MACHINE
|
||||
is set, it is used as the name of the machine type, when accessing object
|
||||
directories of the form obj.MACHINE. If it is not set, it defaults to
|
||||
directories of the form obj.MACHINE. If it is not set, it defaults to
|
||||
the machine type returned by
|
||||
.Xr uname 3 .
|
||||
.br
|
||||
.Nm Note:
|
||||
This option is only used if the -o option to use existing object files is also
|
||||
.br
|
||||
.Nm Note :
|
||||
This option is only used if the -o option to use existing object files is also
|
||||
specified.
|
||||
.It Ev MAKE
|
||||
If the environment variable
|
||||
|
@ -265,7 +265,7 @@ executable to be called. If this environment variable is not set,
|
|||
defaults to
|
||||
.Dq make .
|
||||
.El
|
||||
.Sh EXAMPLE
|
||||
.Sh EXAMPLES
|
||||
Here is an example
|
||||
.Em crunchgen
|
||||
input conf file, named
|
||||
|
@ -305,7 +305,13 @@ and hard-linked to the names of the component programs.
|
|||
.Sh SEE ALSO
|
||||
.Xr crunchide 1 ,
|
||||
.Xr make 1
|
||||
.Sh CAVEATS
|
||||
.Sh AUTHORS
|
||||
.Nm
|
||||
was written by
|
||||
.An James da Silva Aq jds@cs.umd.edu .
|
||||
.sp 0
|
||||
Copyright (c) 1994 University of Maryland. All Rights Reserved.
|
||||
.Sh BUGS
|
||||
While
|
||||
.Nm
|
||||
takes care to eliminate link conflicts between the component programs
|
||||
|
@ -348,8 +354,3 @@ the more general ones later, for eg:
|
|||
.fi
|
||||
.Pp
|
||||
will not have the above problem.
|
||||
.Sh AUTHOR
|
||||
.Nm
|
||||
was written by James da Silva <jds@cs.umd.edu>.
|
||||
.sp 0
|
||||
Copyright (c) 1994 University of Maryland. All Rights Reserved.
|
||||
|
|
Loading…
Reference in New Issue