1.\" $OpenBSD: getprogname.3,v 1.5 2015/05/05 14:37:20 schwarze Exp $ 2.\" 3.\" Copyright (c) 2001 Christopher G. Demetriou 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed for the 17.\" NetBSD Project. See http://www.NetBSD.org/ for 18.\" information about NetBSD. 19.\" 4. The name of the author may not be used to endorse or promote products 20.\" derived from this software without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32.\" 33.Dd $Mdocdate: May 5 2015 $ 34.Dt GETPROGNAME 3 35.Os 36.Sh NAME 37.Nm getprogname , 38.Nm setprogname 39.Nd get/set the name of the current program 40.Sh SYNOPSIS 41.In stdlib.h 42.Ft const char * 43.Fn getprogname "void" 44.Ft void 45.Fn setprogname "const char *name" 46.Sh DESCRIPTION 47These utility functions get and set the current program's name 48as used by various error-reporting functions. 49.Pp 50.Fn getprogname 51returns the name of the current program. 52This function is typically useful when generating error messages 53or other diagnostic output. 54.Pp 55The 56.Fn setprogname 57function sets the name of the program to be the last path component of the 58.Fa name 59argument. 60Internally, only the pointer to the given string is kept as the program name, 61so it should not be modified and the storage for the string must remain valid 62for the rest of the program's lifetime. 63.Sh SEE ALSO 64.Xr err 3 , 65.Xr setproctitle 3 66.Sh HISTORY 67The 68.Fn getprogname 69and 70.Fn setprogname 71functions first appeared in 72.Ox 5.4 73as function-based wrappers around the 74.Bx 4.4 75.Va __progname 76interface. 77.Sh CAVEATS 78The string returned by 79.Fn getprogname 80is supplied by the invoking process and should not be trusted by 81setuid or setgid programs. 82