Module Name: src
Committed By: rillig
Date: Tue Jul 12 22:45:05 UTC 2022
Modified Files:
src/usr.bin/make: make.1
Log Message:
make.1: replace redundant .Ql with .Sq
To generate a diff of this commit:
cvs rdiff -u -r1.310 -r1.311 src/usr.bin/make/make.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/make/make.1
diff -u src/usr.bin/make/make.1:1.310 src/usr.bin/make/make.1:1.311
--- src/usr.bin/make/make.1:1.310 Tue Jul 12 17:45:11 2022
+++ src/usr.bin/make/make.1 Tue Jul 12 22:45:05 2022
@@ -1,4 +1,4 @@
-.\" $NetBSD: make.1,v 1.310 2022/07/12 17:45:11 rillig Exp $
+.\" $NetBSD: make.1,v 1.311 2022/07/12 22:45:05 rillig Exp $
.\"
.\" Copyright (c) 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -61,12 +61,12 @@ If no
makefile option is given,
.Nm
will try to open
-.Ql Pa makefile
+.Sq Pa makefile
then
-.Ql Pa Makefile
+.Sq Pa Makefile
in order to find the specifications.
If the file
-.Ql Pa .depend
+.Sq Pa .depend
exists, it is read (see
.Xr mkdep 1 ) .
.Pp
@@ -229,11 +229,11 @@ Specify that environment variables overr
makefiles.
.It Fl f Ar makefile
Specify a makefile to read instead of the default
-.Ql Pa makefile .
+.Sq Pa makefile .
If
.Ar makefile
is
-.Ql Fl ,
+.Sq Fl ,
standard input is read.
Multiple makefiles may be specified, and are read in the order specified.
.It Fl I Ar directory
@@ -244,7 +244,7 @@ option) is automatically included as par
.It Fl i
Ignore non-zero exit of shell commands in the makefile.
Equivalent to specifying
-.Ql Fl
+.Sq Fl
before each command line in the makefile.
.It Fl J Ar private
This option should
@@ -319,7 +319,7 @@ as an argument).
Display the commands that would have been executed, but do not
actually execute them unless the target depends on the .MAKE special
source (see below) or the command is prefixed with
-.Ql Ic + .
+.Sq Ic + .
.It Fl N
Display the commands which would have been executed, but do not
actually execute any of them; useful for debugging top-level makefiles
@@ -336,7 +336,7 @@ This is the default behavior and the opp
.It Fl s
Do not echo any commands as they are executed.
Equivalent to specifying
-.Ql Ic @
+.Sq Ic @
before each command line in the makefile.
.It Fl T Ar tracefile
When used with the
@@ -493,7 +493,7 @@ While targets can appear in many depende
default only one of these rules may be followed by a creation
script.
If the
-.Ql Ic \&::
+.Sq Ic \&::
operator is used, however, all rules may include scripts and the
scripts are executed in the order found.
.Pp
@@ -505,23 +505,23 @@ in which case that line and the next are
.\" normally ignores it.
.\" However, the tab at the beginning of the following line is removed.
If the first characters of the command are any combination of
-.Ql Ic @ ,
-.Ql Ic + ,
+.Sq Ic @ ,
+.Sq Ic + ,
or
-.Ql Ic \- ,
+.Sq Ic \- ,
the command is treated specially.
A
-.Ql Ic @
+.Sq Ic @
causes the command not to be echoed before it is executed.
A
-.Ql Ic +
+.Sq Ic +
causes the command to be executed even when
.Fl n
is given.
This is similar to the effect of the .MAKE special source,
except that the effect can be limited to a single line of a script.
A
-.Ql Ic \-
+.Sq Ic \-
in compatibility mode
causes any non-zero exit status of the command line to be ignored.
.Pp
@@ -538,11 +538,11 @@ it will be passed to the shell; otherwis
.Nm
will attempt direct execution.
If a line starts with
-.Ql Ic \-
+.Sq Ic \-
and the shell has ErrCtl enabled then failure of the command line
will be ignored as in compatibility mode.
Otherwise
-.Ql Ic \-
+.Sq Ic \-
affects the entire job;
the script will stop at the first command line that fails,
but the target will not be deemed to have failed.
@@ -576,14 +576,14 @@ Since
will
.Xr chdir 2
to
-.Ql Va .OBJDIR
+.Sq Va .OBJDIR
before executing any targets, each child process
starts with that as its current working directory.
.Sh VARIABLE ASSIGNMENTS
Variables in make behave much like macros in the C preprocessor.
.Pp
Variable assignments have the form
-.Ql Ar NAME No Ar op No Ar value ,
+.Sq Ar NAME No Ar op No Ar value ,
where:
.Bl -tag -width Ds
.It Ar NAME
@@ -743,34 +743,34 @@ The seven built-in local variables are a
.Bl -tag -width ".ARCHIVE" -offset indent
.It Va .ALLSRC
The list of all sources for this target; also known as
-.Ql Va \&> .
+.Sq Va \&> .
.It Va .ARCHIVE
The name of the archive file; also known as
-.Ql Va \&! .
+.Sq Va \&! .
.It Va .IMPSRC
In suffix-transformation rules, the name/path of the source from which the
target is to be transformed (the
.Dq implied
source); also known as
-.Ql Va \&< .
+.Sq Va \&< .
It is not defined in explicit rules.
.It Va .MEMBER
The name of the archive member; also known as
-.Ql Va % .
+.Sq Va % .
.It Va .OODATE
The list of sources for this target that were deemed out-of-date; also
known as
-.Ql Va \&? .
+.Sq Va \&? .
.It Va .PREFIX
The file prefix of the target, containing only the file portion, no suffix
or preceding directory components; also known as
-.Ql Va * .
+.Sq Va * .
The suffix must be one of the known suffixes declared with
.Ic .SUFFIXES
or it will not be recognized.
.It Va .TARGET
The name of the target; also known as
-.Ql Va @ .
+.Sq Va @ .
For compatibility with other makes this is an alias for
.Ic .ARCHIVE
in archive member rules.
@@ -778,13 +778,13 @@ in archive member rules.
.Pp
The shorter forms
.Ql ( Va > ,
-.Ql Va \&! ,
-.Ql Va < ,
-.Ql Va % ,
-.Ql Va \&? ,
-.Ql Va * ,
+.Sq Va \&! ,
+.Sq Va < ,
+.Sq Va % ,
+.Sq Va \&? ,
+.Sq Va * ,
and
-.Ql Va @ )
+.Sq Va @ )
are permitted for backward
compatibility with historical makefiles and legacy POSIX make and are
not recommended.
@@ -794,7 +794,7 @@ Variants of these variables with the pun
or
.Ql F ,
e.g.\&
-.Ql Va $(@D) ,
+.Sq Va $(@D) ,
are legacy forms equivalent to using the
.Ql :H
and
@@ -807,11 +807,11 @@ makefiles and POSIX but are not recommen
Four of the local variables may be used in sources on dependency lines
because they expand to the proper value for each target on the line.
These variables are
-.Ql Va .TARGET ,
-.Ql Va .PREFIX ,
-.Ql Va .ARCHIVE ,
+.Sq Va .TARGET ,
+.Sq Va .PREFIX ,
+.Sq Va .ARCHIVE ,
and
-.Ql Va .MEMBER .
+.Sq Va .MEMBER .
.Ss Additional built-in variables
In addition,
.Nm
@@ -826,7 +826,7 @@ A path to the directory where
.Nm
was executed.
Refer to the description of
-.Ql Ev PWD
+.Sq Ev PWD
for more details.
.It Va .INCLUDEDFROMDIR
The directory of the file this Makefile was included from.
@@ -849,7 +849,7 @@ because it is more compatible with other
and cannot be confused with the special target with the same name.
.It Va .MAKE.DEPENDFILE
Names the makefile (default
-.Ql Pa .depend )
+.Sq Pa .depend )
from which generated dependencies are read.
.It Va .MAKE.EXPAND_VARIABLES
A boolean that controls the default behavior of the
@@ -891,7 +891,7 @@ apparent variable assignments in depende
treated as normal sources.
.It Ev MAKEFLAGS
The environment variable
-.Ql Ev MAKEFLAGS
+.Sq Ev MAKEFLAGS
may contain anything that
may be specified on
.Nm Ns 's
@@ -899,7 +899,7 @@ command line.
Anything specified on
.Nm Ns 's
command line is appended to the
-.Ql Ev MAKEFLAGS
+.Sq Ev MAKEFLAGS
variable which is then
entered into the environment for all programs which
.Nm
@@ -918,8 +918,8 @@ to protect things which should only be e
.It Va .MAKE.MAKEFILE_PREFERENCE
The ordered list of makefile names
(default
-.Ql Pa makefile ,
-.Ql Pa Makefile )
+.Sq Pa makefile ,
+.Sq Pa Makefile )
that
.Nm
will look for.
@@ -954,7 +954,7 @@ The captured output can be very useful w
Normally
.Nm
will not create .meta files in
-.Ql Va .CURDIR .
+.Sq Va .CURDIR .
This can be overridden by setting
.Va bf
to a value which represents True.
@@ -1021,7 +1021,7 @@ information.
Provides a list of path prefixes that should be ignored;
because the contents are expected to change over time.
The default list includes:
-.Ql Pa /dev /etc /proc /tmp /var/run /var/tmp
+.Sq Pa /dev /etc /proc /tmp /var/run /var/tmp
.It Va .MAKE.META.IGNORE_PATTERNS
Provides a list of patterns to match against pathnames.
Ignore any that match.
@@ -1035,16 +1035,16 @@ The default value is:
.It Va .MAKEOVERRIDES
This variable is used to record the names of variables assigned to
on the command line, so that they may be exported as part of
-.Ql Ev MAKEFLAGS .
+.Sq Ev MAKEFLAGS .
This behavior can be disabled by assigning an empty value to
-.Ql Va .MAKEOVERRIDES
+.Sq Va .MAKEOVERRIDES
within a makefile.
Extra variables can be exported from a makefile
by appending their names to
-.Ql Va .MAKEOVERRIDES .
-.Ql Ev MAKEFLAGS
+.Sq Va .MAKEOVERRIDES .
+.Sq Ev MAKEFLAGS
is re-exported whenever
-.Ql Va .MAKEOVERRIDES
+.Sq Va .MAKEOVERRIDES
is modified.
.It Va .MAKE.PATH_FILEMON
If
@@ -1081,21 +1081,21 @@ The group-id running
When
.Nm
stops due to an error, it sets
-.Ql Va .ERROR_TARGET
+.Sq Va .ERROR_TARGET
to the name of the target that failed,
-.Ql Va .ERROR_CMD
+.Sq Va .ERROR_CMD
to the commands of the failed target,
and in "meta" mode, it also sets
-.Ql Va .ERROR_CWD
+.Sq Va .ERROR_CWD
to the
.Xr getcwd 3 ,
and
-.Ql Va .ERROR_META_FILE
+.Sq Va .ERROR_META_FILE
to the path of the meta file (if any) describing the failed target.
It then prints its name and the value of
-.Ql Va .CURDIR
+.Sq Va .CURDIR
as well as the value of any variables named in
-.Ql Va MAKE_PRINT_VAR_ON_ERROR .
+.Sq Va MAKE_PRINT_VAR_ON_ERROR .
.It Va .newline
This variable is simply assigned a newline character as its value.
This allows expansions using the
@@ -1103,7 +1103,7 @@ This allows expansions using the
modifier to put a newline between
iterations of the loop rather than a space.
For example, the printing of
-.Ql Va MAKE_PRINT_VAR_ON_ERROR
+.Sq Va MAKE_PRINT_VAR_ON_ERROR
could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
.It Va .OBJDIR
A path to the directory where the targets are built.
@@ -1115,13 +1115,13 @@ to the following directories in order an
.Ev ${MAKEOBJDIRPREFIX}${.CURDIR}
.Pp
(Only if
-.Ql Ev MAKEOBJDIRPREFIX
+.Sq Ev MAKEOBJDIRPREFIX
is set in the environment or on the command line.)
.It
.Ev ${MAKEOBJDIR}
.Pp
(Only if
-.Ql Ev MAKEOBJDIR
+.Sq Ev MAKEOBJDIR
is set in the environment or on the command line.)
.It
.Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE}
@@ -1138,42 +1138,42 @@ so expressions such as
.Dl ${.CURDIR:S,^/usr/src,/var/obj,}
may be used.
This is especially useful with
-.Ql Ev MAKEOBJDIR .
+.Sq Ev MAKEOBJDIR .
.Pp
-.Ql Va .OBJDIR
+.Sq Va .OBJDIR
may be modified in the makefile via the special target
-.Ql Ic .OBJDIR .
+.Sq Ic .OBJDIR .
In all cases,
.Nm
will
.Xr chdir 2
to the specified directory if it exists, and set
-.Ql Va .OBJDIR
+.Sq Va .OBJDIR
and
-.Ql Ev PWD
+.Sq Ev PWD
to that directory before executing any targets.
.Pp
Except in the case of an explicit
-.Ql Ic .OBJDIR
+.Sq Ic .OBJDIR
target,
.Nm
will check that the specified directory is writable and ignore it if not.
This check can be skipped by setting the environment variable
-.Ql Ev MAKE_OBJDIR_CHECK_WRITABLE
+.Sq Ev MAKE_OBJDIR_CHECK_WRITABLE
to "no".
.
.It Va .PARSEDIR
A path to the directory of the current
-.Ql Pa Makefile
+.Sq Pa Makefile
being parsed.
.It Va .PARSEFILE
The basename of the current
-.Ql Pa Makefile
+.Sq Pa Makefile
being parsed.
This variable and
-.Ql Va .PARSEDIR
+.Sq Va .PARSEDIR
are both set only while the
-.Ql Pa Makefiles
+.Sq Pa Makefiles
are being parsed.
If you want to retain their current values, assign them to a variable
using assignment with expansion:
@@ -1183,32 +1183,32 @@ A variable that represents the list of d
.Nm
will search for files.
The search list should be updated using the target
-.Ql Va .PATH
+.Sq Va .PATH
rather than the variable.
.It Ev PWD
Alternate path to the current directory.
.Nm
normally sets
-.Ql Va .CURDIR
+.Sq Va .CURDIR
to the canonical path given by
.Xr getcwd 3 .
However, if the environment variable
-.Ql Ev PWD
+.Sq Ev PWD
is set and gives a path to the current directory, then
.Nm
sets
-.Ql Va .CURDIR
+.Sq Va .CURDIR
to the value of
-.Ql Ev PWD
+.Sq Ev PWD
instead.
This behavior is disabled if
-.Ql Ev MAKEOBJDIRPREFIX
+.Sq Ev MAKEOBJDIRPREFIX
is set or
-.Ql Ev MAKEOBJDIR
+.Sq Ev MAKEOBJDIR
contains a variable transform.
-.Ql Ev PWD
+.Sq Ev PWD
is set to the value of
-.Ql Va .OBJDIR
+.Sq Va .OBJDIR
for all programs which
.Nm
executes.
@@ -1228,7 +1228,7 @@ lists of directories that
will search for files.
The variable is supported for compatibility with old make programs only,
use
-.Ql Va .PATH
+.Sq Va .PATH
instead.
.El
.Ss Variable modifiers
@@ -1283,7 +1283,7 @@ to single spaces.
.
.It Cm \&:N Ns Ar pattern
This is identical to
-.Ql Cm \&:M ,
+.Sq Cm \&:M ,
but selects all words which do not match
.Ar pattern .
.It Cm \&:O
@@ -1382,12 +1382,12 @@ Converts variable to upper-case letters.
Causes the value to be treated as a single word
(possibly containing embedded white space).
See also
-.Ql Cm \&:[*] .
+.Sq Cm \&:[*] .
.It Cm \&:tw
Causes the value to be treated as a sequence of
words delimited by white space.
See also
-.Ql Cm \&:[@] .
+.Sq Cm \&:[@] .
.Sm off
.It Cm \&:S No \&/ Ar old_string No \&/ Ar new_string No \&/ Op Cm 1gW
.Sm on
@@ -1643,7 +1643,7 @@ preceded with something to keep
happy.
.Pp
The
-.Ql Cm \&::
+.Sq Cm \&::
helps avoid false matches with the
.At V
style
@@ -1676,7 +1676,7 @@ causing a value to be treated as a singl
An empty value, or a value that consists entirely of white-space,
is treated as a single word.
For the purposes of the
-.Ql Cm \&:[]
+.Sq Cm \&:[]
modifier, the words are indexed both forwards using positive integers
(where index 1 represents the first word),
and backwards using negative integers
@@ -1698,7 +1698,7 @@ to
.Ar end ,
inclusive.
For example,
-.Ql Cm \&:[2..-1]
+.Sq Cm \&:[2..-1]
selects all words from the second word to the last word.
If
.Ar start
@@ -1706,13 +1706,13 @@ is greater than
.Ar end ,
then the words are output in reverse order.
For example,
-.Ql Cm \&:[-1..1]
+.Sq Cm \&:[-1..1]
selects all the words from last to first.
If the list is already ordered, then this effectively reverses
the list, but it is more efficient to use
-.Ql Cm \&:Or
+.Sq Cm \&:Or
instead of
-.Ql Cm \&:O:[-1..1] .
+.Sq Cm \&:O:[-1..1] .
.\" :[*]
.It Cm \&*
Causes subsequent modifiers to treat the value as a single word
@@ -1723,7 +1723,7 @@ in Bourne shell.
.\" :[0]
.It 0
Means the same as
-.Ql Cm \&:[*] .
+.Sq Cm \&:[*] .
.\" :[*]
.It Cm \&@
Causes subsequent modifiers to treat the value as a sequence of words
@@ -1850,14 +1850,14 @@ PATH := ${PATH}
.Pp
.Ed
Would result in an environment containing only
-.Ql Ev PATH ,
+.Sq Ev PATH ,
which is the minimal useful environment.
Actually
-.Ql Ev .MAKE.LEVEL
+.Sq Ev .MAKE.LEVEL
will also be pushed into the new environment.
.It Ic .warning Ar message
The message prefixed by
-.Ql Pa warning:
+.Sq Pa warning:
is printed along with the name of the makefile and line number.
.It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ...
Test the value of an expression.
@@ -1873,29 +1873,29 @@ Test the target being built.
Reverse the sense of the last conditional.
.It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ...
A combination of
-.Ql Ic .else
+.Sq Ic .else
followed by
-.Ql Ic .if .
+.Sq Ic .if .
.It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
A combination of
-.Ql Ic .else
+.Sq Ic .else
followed by
-.Ql Ic .ifdef .
+.Sq Ic .ifdef .
.It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
A combination of
-.Ql Ic .else
+.Sq Ic .else
followed by
-.Ql Ic .ifndef .
+.Sq Ic .ifndef .
.It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
A combination of
-.Ql Ic .else
+.Sq Ic .else
followed by
-.Ql Ic .ifmake .
+.Sq Ic .ifmake .
.It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ...
A combination of
-.Ql Ic .else
+.Sq Ic .else
followed by
-.Ql Ic .ifnmake .
+.Sq Ic .ifnmake .
.It Ic .endif
End the body of the conditional.
.El
@@ -1919,11 +1919,11 @@ will only evaluate a conditional as far
its value.
Parentheses may be used to change the order of evaluation.
The boolean operator
-.Ql Ic \&!
+.Sq Ic \&!
may be used to logically negate an entire
conditional.
It is of higher precedence than
-.Ql Ic \&&& .
+.Sq Ic \&&& .
.Pp
The value of
.Ar expression
@@ -1965,9 +1965,9 @@ preceded by 0x, otherwise it is decimal;
The standard C relational operators are all supported.
If after
variable expansion, either the left or right hand side of a
-.Ql Ic ==
+.Sq Ic ==
or
-.Ql Ic "!="
+.Sq Ic "!="
operator is not a numerical value, then
string comparison is performed between the expanded
variables.
@@ -1984,17 +1984,17 @@ or
.Dq defined
expression is applied to it, depending on the form of the conditional.
If the form is
-.Ql Ic .ifdef ,
-.Ql Ic .ifndef ,
+.Sq Ic .ifdef ,
+.Sq Ic .ifndef ,
or
-.Ql Ic .if
+.Sq Ic .if
the
.Dq defined
expression is applied.
Similarly, if the form is
-.Ql Ic .ifmake
+.Sq Ic .ifmake
or
-.Ql Ic .ifnmake ,
+.Sq Ic .ifnmake ,
the
.Dq make
expression is applied.
@@ -2003,9 +2003,9 @@ If the conditional evaluates to true the
as before.
If it evaluates to false, the following lines are skipped.
In both cases this continues until a
-.Ql Ic .else
+.Sq Ic .else
or
-.Ql Ic .endif
+.Sq Ic .endif
is found.
.Pp
For loops are typically used to apply a set of rules to a list of files.
@@ -2256,13 +2256,13 @@ Synonym for
for compatibility with other pmake variants.
.It Ic .OBJDIR
The source is a new value for
-.Ql Va .OBJDIR .
+.Sq Va .OBJDIR .
If it exists,
.Nm
will
.Xr chdir 2
to it and update the value of
-.Ql Va .OBJDIR .
+.Sq Va .OBJDIR .
.It Ic .ORDER
In parallel mode, the named targets are made in sequence.
This ordering does not add targets to the list of targets to be made.
@@ -2420,7 +2420,7 @@ may only be set in the environment or on
.Nm
and not as makefile variables;
see the description of
-.Ql Va .OBJDIR
+.Sq Va .OBJDIR
for more details.
.Sh FILES
.Bl -tag -width /usr/share/mk -compact
