$OpenBSD: getprogname.3,v 1.6 2023/02/22 06:31:51 guenther Exp $

Copyright (c) 2001 Christopher G. Demetriou
All rights reserved.

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.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed for the
NetBSD Project. See http://www.NetBSD.org/ for
information about NetBSD.
4. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.

.Dd $Mdocdate: May 5 2015 $ .Dt GETPROGNAME 3 .Os .Sh NAME .Nm getprogname , .Nm setprogname .Nd get or set the name of the current program .Sh SYNOPSIS n stdlib.h .Ft const char * .Fn getprogname "void" .Ft void .Fn setprogname "const char *name" .Sh DESCRIPTION These utility functions get and set the current program's name as used by various error-reporting functions.

p .Fn getprogname returns the name of the current program. This function is typically useful when generating error messages or other diagnostic output.

p The .Fn setprogname function sets the name of the program to be the last path component of the .Fa name argument. Internally, only the pointer to the given string is kept as the program name, so it should not be modified and the storage for the string must remain valid for the rest of the program's lifetime. .Sh SEE ALSO .Xr err 3 , .Xr setproctitle 3 .Sh HISTORY The .Fn getprogname and .Fn setprogname functions first appeared in .Ox 5.4 as function-based wrappers around the x 4.4 .Va __progname interface. .Sh CAVEATS The string returned by .Fn getprogname is supplied by the invoking process and should not be trusted by setuid or setgid programs.