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

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