GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
SETPROCTITLE(3) FreeBSD Library Functions Manual SETPROCTITLE(3)

setproctitle
set process title

#include <sys/types.h>
#include <unistd.h>
void
setproctitle(const char *fmt, ...);
void
setproctitle_fast(const char *fmt, ...);

The setproctitle() library routine sets the process title that appears on the ps(1) command. The setproctitle_fast() variant is optimized for high frequency updates, but may make the ps(1) command slightly slower by not updating the kernel cache of the program arguments.
The title is set from the executable's name, followed by the result of a printf(3) style expansion of the arguments as specified by the fmt argument. If the fmt argument begins with a “-” character, the executable's name is skipped.
If fmt is NULL, the process title is restored.

To set the title on a daemon to indicate its activity:
setproctitle("talking to %s", inet_ntoa(addr));

ps(1), w(1), kvm(3), kvm_getargv(3), printf(3)

The setproctitle() function is implicitly non-standard. Other methods of causing the ps(1) command line to change, including copying over the argv[0] string are also implicitly non-portable. It is preferable to use an operating system supplied setproctitle() if present.
Unfortunately, it is possible that there are other calling conventions to other versions of setproctitle(), although none have been found by the author as yet. This is believed to be the predominant convention.
It is thought that the implementation is compatible with other systems, including NetBSD and BSD/OS.

The setproctitle() function first appeared in FreeBSD 2.2. The setproctitle_fast() function first appeared in FreeBSD 12. Other operating systems have similar functions.

Peter Wemm <peter@FreeBSD.org> stole the idea from the Sendmail 8.7.3 source code by Eric Allman <eric@sendmail.org>.

Never pass a string with user-supplied data as a format without using ‘%s’. An attacker can put format specifiers in the string to mangle your stack, leading to a possible security hole. This holds true even if the string was built using a function like snprintf(), as the resulting string may still contain user-supplied conversion specifiers for later interpolation by setproctitle().
Always use the proper secure idiom:
setproctitle("%s", string);
July 4, 2018 FreeBSD 12.0-RELEASE

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.