d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c1a3d7f206
freebsd-nq/lib/libc/gen/setproctitle.3

136 lines
3.5 KiB
Groff
Raw Normal View History

mdoc: consistently spell our email addresses <foo@FreeBSD.org> Reviewed by: ru
2010-05-19 08:57:53 +00:00
.\" Copyright (c) 1995 Peter Wemm <peter@FreeBSD.org>
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, is permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice immediately at the beginning of the file, without modification,
.\" 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. This work was done expressly for inclusion into FreeBSD. Other use
.\" is permitted provided this notation is included.
.\" 4. Absolutely no warranty of function or purpose is made by the author
.\" Peter Wemm.
.\" 5. Modifications may be freely made to this file providing the above
.\" conditions are met.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.\"
.\" The following requests are required for all man pages.
Reference setprogname(3) in setproctitle(3) The reference to setproctitle(3) in the setprogname(3) manual is already in place. MFC after: 3 days
2020-11-13 13:47:18 +00:00
.Dd November 13, 2020
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Dt SETPROCTITLE 3
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Sh NAME
.Nm setproctitle
Add a missing Nm macro All functions documented in a manual page should be enumerated with the Nm macros.
2020-11-13 14:56:34 +00:00
.Nm setproctitle_fast
Add warnings about trusting user-supplied data. Reviewed by: ru Approved by: murray Obtained from: OpenBSD
2001-05-25 20:42:40 +00:00
.Nd set process title
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/types.h
.In unistd.h
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Ft void
.Fn setproctitle "const char *fmt" "..."
Add setproctitle_fast(3) for frequent callers. Some applications, notably PostgreSQL, want to call setproctitle() very often. It's slow. Provide an alternative cheap way of updating process titles without making any syscalls, instead requiring other processes (top, ps etc) to do a bit more work to retrieve the data. This uses a pre-existing code path inherited from ancient BSD, which always did it that way. Submitted by: Thomas Munro MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16111
2018-07-04 13:31:16 +00:00
.Ft void
.Fn setproctitle_fast "const char *fmt" "..."
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Sh DESCRIPTION
The
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn setproctitle
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
library routine sets the process title that appears on the
.Xr ps 1
command.
Add setproctitle_fast(3) for frequent callers. Some applications, notably PostgreSQL, want to call setproctitle() very often. It's slow. Provide an alternative cheap way of updating process titles without making any syscalls, instead requiring other processes (top, ps etc) to do a bit more work to retrieve the data. This uses a pre-existing code path inherited from ancient BSD, which always did it that way. Submitted by: Thomas Munro MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16111
2018-07-04 13:31:16 +00:00
The
.Fn setproctitle_fast
variant is optimized for high frequency updates, but may make the
.Xr ps 1
command slightly slower by not updating the kernel cache of the program
arguments.
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Pp
The title is set from the executable's name, followed by the
result of a
.Xr printf 3
style expansion of the arguments as specified by the
.Va fmt
argument.
If the format string passed to setproctitle begins with a '-' character, skip the program name when setting the process title. Ansified with extreme prejudice. Reviewed by: peter
2000-08-01 06:37:09 +00:00
If the
.Va fmt
argument begins with a
.Dq -
character, the executable's name is skipped.
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Pp
If
.Va fmt
Make setproctitle(NULL) restore all of the original arguments (if it's able).
1999-11-17 21:12:17 +00:00
is NULL, the process title is restored.
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Sh EXAMPLES
Fix punctuation: "it's" -> "its"
1997-04-17 23:31:47 +00:00
To set the title on a daemon to indicate its activity:
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Bd -literal -offset indent
setproctitle("talking to %s", inet_ntoa(addr));
.Ed
.Sh SEE ALSO
.Xr ps 1 ,
.Xr w 1 ,
Reference setprogname(3) in setproctitle(3) The reference to setproctitle(3) in the setprogname(3) manual is already in place. MFC after: 3 days
2020-11-13 13:47:18 +00:00
.Xr setprogname 3 ,
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Xr kvm 3 ,
.Xr kvm_getargv 3 ,
.Xr printf 3
.Sh STANDARDS
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
The
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn setproctitle
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
function
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
is implicitly non-standard.
Other methods of causing the
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Xr ps 1
command line to change, including copying over the argv[0] string are
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
also implicitly non-portable.
It is preferable to use an operating system
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
supplied
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn setproctitle
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
if present.
.Pp
Unfortunately, it is possible that there are other calling conventions
to other versions of
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn setproctitle ,
Mechanically kill hard sentence breaks.
2004-07-02 23:52:20 +00:00
although none have been found by the author as yet.
This is believed to be
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
the predominant convention.
.Pp
Another round of spelling fixes.
1996-01-30 18:13:11 +00:00
It is thought that the implementation is compatible with other systems,
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
including
mdoc(7)'fy Reviewed by: mpp
1999-09-21 19:39:27 +00:00
.Nx
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
and
mdoc(7) police: s;BSD/OS;.Bsx; where appropriate.
2001-08-13 17:07:40 +00:00
.Bsx .
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
.Sh HISTORY
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
The
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn setproctitle
mdoc(7) police: "The .Fn function".
2002-12-18 10:13:54 +00:00
function
Some minor man page cleanup.
1996-08-23 20:52:53 +00:00
first appeared in
.Fx 2.2 .
Add setproctitle_fast(3) for frequent callers. Some applications, notably PostgreSQL, want to call setproctitle() very often. It's slow. Provide an alternative cheap way of updating process titles without making any syscalls, instead requiring other processes (top, ps etc) to do a bit more work to retrieve the data. This uses a pre-existing code path inherited from ancient BSD, which always did it that way. Submitted by: Thomas Munro MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16111
2018-07-04 13:31:16 +00:00
The
.Fn setproctitle_fast
function first appeared in
.Fx 12 .
Some minor man page cleanup.
1996-08-23 20:52:53 +00:00
Other operating systems have
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
similar functions.
.Sh AUTHORS
log
2000-11-22 09:23:54 +00:00
.An -nosplit
use .Mt to mark up email addresses consistently (part4) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-23 08:25:03 +00:00
.An Peter Wemm Aq Mt peter@FreeBSD.org
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
stole the idea from the
Some minor man page cleanup.
1996-08-23 20:52:53 +00:00
.Sy "Sendmail 8.7.3"
Bring in an initial version of setproctitle().. This is intended to replace the dozen other various hacks in the code that do all sorts of crude things including spamming the envrionment strings with the new argv string. This version is mainly inspired by the sendmail version, with a couple of ideas taken from the NetBSD implementation as well.
1995-12-26 22:50:08 +00:00
source code by
use .Mt to mark up email addresses consistently (part4) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de>
2014-06-23 08:25:03 +00:00
.An Eric Allman Aq Mt eric@sendmail.org .
Add warnings about trusting user-supplied data. Reviewed by: ru Approved by: murray Obtained from: OpenBSD
2001-05-25 20:42:40 +00:00
.Sh BUGS
Never pass a string with user-supplied data as a format without using
.Ql %s .
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
An attacker can put format specifiers in the string to mangle your stack,
Add warnings about trusting user-supplied data. Reviewed by: ru Approved by: murray Obtained from: OpenBSD
2001-05-25 20:42:40 +00:00
leading to a possible security hole.
This holds true even if the string was built using a function like
.Fn snprintf ,
as the resulting string may still contain user-supplied conversion specifiers
for later interpolation by
.Fn setproctitle .
.Pp
Always use the proper secure idiom:
.Pp
.Dl setproctitle("%s", string);
Reference in New Issue Copy Permalink