[thirdparty/man-pages.git] / man3 / program_invocation_name.3

.\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" %%%LICENSE_START(PERMISSIVE_MISC)
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be
.\" included in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
.\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
.\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
.\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.\" %%%LICENSE_END
.\"
.TH INVOCATION_NAME 3 2006-04-29 "GNU" "Linux Programmer's Manual"
.SH NAME
program_invocation_name, program_invocation_short_name \- \
obtain name used to invoke calling program
.SH SYNOPSIS
.nf
.BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
.B #include <errno.h>

.BI "extern char *" program_invocation_name ;
.BI "extern char *" program_invocation_short_name ;
.fi
.SH DESCRIPTION
.I program_invocation_name
contains the name that was used to invoke the calling program.
This is the same as the value of
.I argv[0]
in
.IR main (),
with the difference that the scope of
.I program_invocation_name
is global.

.I program_invocation_short_name
contains the basename component of name that was used to invoke
the calling program.
That is, it is the same value as
.IR program_invocation_name ,
with all text up to and including the final slash (/), if any, removed.

These variables are automatically initialized by the glibc run-time
startup code.
.SH CONFORMING TO
These variables are GNU extensions, and should not be
used in programs intended to be portable.
.SH NOTES
The Linux-specific
.I /proc/[number]/cmdline
file provides access to similar information.
.SH SEE ALSO
.BR proc (5)
Commit	Line	Data
c11b1abf	1	.\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
900064d4	2	.\"
7c576f45	3	.\" %%%LICENSE_START(PERMISSIVE_MISC)
900064d4 MK	4	.\" Permission is hereby granted, free of charge, to any person obtaining
	5	.\" a copy of this software and associated documentation files (the
	6	.\" "Software"), to deal in the Software without restriction, including
	7	.\" without limitation the rights to use, copy, modify, merge, publish,
	8	.\" distribute, sublicense, and/or sell copies of the Software, and to
	9	.\" permit persons to whom the Software is furnished to do so, subject to
	10	.\" the following conditions:
	11	.\"
	12	.\" The above copyright notice and this permission notice shall be
	13	.\" included in all copies or substantial portions of the Software.
	14	.\"
	15	.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	16	.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	17	.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
	18	.\" IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
	19	.\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
	20	.\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
	21	.\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8ff7380d	22	.\" %%%LICENSE_END
7c576f45	23	.\"
fd34763b	24	.TH INVOCATION_NAME 3 2006-04-29 "GNU" "Linux Programmer's Manual"
900064d4 MK	25	.SH NAME
	26	program_invocation_name, program_invocation_short_name \- \
	27	obtain name used to invoke calling program
	28	.SH SYNOPSIS
	29	.nf
b80f966b	30	.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */"
900064d4 MK	31	.B #include <errno.h>
	32
	33	.BI "extern char *" program_invocation_name ;
	34	.BI "extern char *" program_invocation_short_name ;
	35	.fi
	36	.SH DESCRIPTION
	37	.I program_invocation_name
	38	contains the name that was used to invoke the calling program.
c13182ef	39	This is the same as the value of
900064d4	40	.I argv[0]
c13182ef	41	in
900064d4	42	.IR main (),
c13182ef	43	with the difference that the scope of
900064d4 MK	44	.I program_invocation_name
	45	is global.
	46
	47	.I program_invocation_short_name
c13182ef	48	contains the basename component of name that was used to invoke
900064d4 MK	49	the calling program.
	50	That is, it is the same value as
	51	.IR program_invocation_name ,
	52	with all text up to and including the final slash (/), if any, removed.
	53
d9bfdb9c	54	These variables are automatically initialized by the glibc run-time
900064d4	55	startup code.
47297adb	56	.SH CONFORMING TO
2b2581ee MK	57	These variables are GNU extensions, and should not be
2b2581ee MK	58	used in programs intended to be portable.
900064d4 MK	59	.SH NOTES
	60	The Linux-specific
	61	.I /proc/[number]/cmdline
	62	file provides access to similar information.
900064d4	63	.SH SEE ALSO
0a4f8b7b	64	.BR proc (5)