1dnl $Id: m4.utility,v 10.17 2002/08/24 18:24:55 bostic Exp $
2
3dnl m4_utilenv --
4dnl	-h environment section
5dnl	#1: utility name
6define(m4_utilenv, [dnl
7m4_tagbegin
8m4_tag(DB_HOME, [dnl
9If the m4_option(h) option is not specified and the environment variable
10DB_HOME is set, it is used as the path of the database home, as described
11in m4_ref(dbenv_open).])
12m4_tagend])
13
14define(m4_hflag, [dnl
15m4_tagopt(h, [Specify a home directory for the database environment; by
16default, the current working directory is used.])])
17
18dnl m4_Lflag --
19dnl	Log-the-pid option.
20dnl	#1: utility name
21define(m4_Lflag, [dnl
22m4_tagopt(L, [dnl
23Log the execution of the m4_ref($1) utility to the specified file in the
24following format, where m4_italic([###]) is the process ID, and the date
25is the time the utility was started.
26m4_indent([$1: [###] Wed Jun 15 01:23:45 EDT 1995])
27This file will be removed if the m4_ref($1) utility exits gracefully.])])
28
29define(m4_Nflag, [dnl
30m4_tagopt(N, [dnl
31Do not acquire shared region mutexes while running.  Other problems,
32such as potentially fatal errors in m4_db, will be ignored as well.
33This option is intended only for debugging errors, and should not be
34used under any other circumstances.])])
35
36define(m4_Pflag, [dnl
37m4_tagopt(P, [dnl
38Specify an environment password.  Although m4_db utilities overwrite
39password strings as soon as possible, be aware there may be a window of
40vulnerability on systems where unprivileged users can see command-line
41arguments or where utilities are not able to overwrite the memory
42containing the command-line arguments.])])
43
44define(m4_Vflag, [dnl
45m4_tagopt(V, [dnl
46Write the library version number to the standard output, and exit.])])
47
48dnl m4_utilexit --
49dnl	Exit macro.
50dnl	#1: utility name
51define(m4_utilexit, [m4_p([dnl
52The m4_ref($1) utility exits 0 on success, and __GT__0 if an error occurs.])])
53
54dnl m4_detach --
55dnl	Detaching from the environment paragraph.
56dnl	#1: utility name
57dnl	#2: "uses" or "may be used with"
58define(m4_detach, [m4_p([dnl
59The m4_ref($1) utility $2 a m4_db environment (as described for the
60m4_option(h) option, the environment variable m4_envvar(DB_HOME), or
61because the utility was run in a directory containing a m4_db
62environment).  In order to avoid environment corruption when using a
63m4_db environment, m4_ref($1) should always be given the chance to
64detach from the environment and exit gracefully.  To cause m4_ref($1)
65to release all environment resources and exit cleanly, send it an
66interrupt signal (SIGINT).])])
67