Differential D27236 Diff 79678 lib/libutil/getlocalbase.3

Changeset View

Standalone View

lib/libutil/getlocalbase.3

Property	Old Value	New Value
svn:eol-style	null	native \ No newline at end of property
svn:keywords	null	FreeBSD=%H \ No newline at end of property
svn:mime-type	null	text/plain \ No newline at end of property

				.\"
				.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
				.\"
				.\" Copyright 2020 Scott Long
				.\" Copyright 2020 Stefan Eßer
				.\"
				.\" Redistribution and use in source and binary forms, with or without
				.\" modification, are permitted provided that the following conditions
				.\" are met:
				.\" 1. Redistributions of source code must retain the above copyright
				.\" notice, this list of conditions and the following disclaimer.
				.\" 2. Redistributions in binary form must reproduce the above copyright
				.\" notice, this list of conditions and the following disclaimer in the
				.\" documentation and/or other materials provided with the distribution.
				.\"
				.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
				.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
				.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
				.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
				.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
				.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
				.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
				.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
				.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
				.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
				.\" SUCH DAMAGE.
				.\"
				.\" $FreeBSD$
				.\"
				.Dd Nov 16, 2020
				.Dt GETLOCALBASE 3
				.Os
				.Sh NAME
				.Nm getlocalbase
				.Nd "return the path to the local software directory"
				.Sh LIBRARY
				.Lb libutil
				.Sh SYNOPSIS
				.In libutil.h
				.Ft const char*
				.Fn getlocalbase "void"
				.Sh DESCRIPTION
				The
				.Fn getlocalbase
				function returns the path to the local software base directory.
				Normally this is the
				.Pa /usr/local
				directory.
				First the
				.Ev LOCALBASE
				environment variable is checked.
				If that doesn't exist then the
				.Va user.localbase
				sysctl is checked.
				If that also doesn't exist then the value of the
				.Dv _PATH_LOCALBASE
				compile-time variable is used.
				If that is undefined then the default of
				.Pa /usr/local
				is used.
				.Pp
				The value returned by the
				.Fn getlocalbase
				function shall not be modified.
				.Sh IMPLEMENTATION NOTES
				Calls to
				.Fn getlocalbase
				will perform a setugid check on the running binary before checking the
				environment.
				.Sh RETURN VALUE
				The
				.Fn getlocalbase
				function always succeeds and returns a pointer to a string, whose length
				may exceed MAXPATHLEN if it has been derived from the environment variable
				LOCALBASE.
				No length checks are performed on the result.
				.Sh ENVIRONMENT
				The
				.Fn getlocalbase
				library function retrieves the
				.Ev LOCALBASE
				environment variable.
				.Sh ERRORS
				The
				.Fn getlocalbase
				function always succeeds.
				.Sh SEE ALSO
				.Xr env 1 ,
				.Xr src.conf 5 ,
				.Xr sysctl 8
				.Sh HISTORY
				The
				.Nm
				library function first appeared in
				.Fx 13.0 .
				.Sh AUTHORS
				This
				manual page was written by
				.An Scott Long Aq Mt scottl@FreeBSD.org and Stefan Eßer Aq Mt se@FreeBSD.org .