1 .\" Copyright (c) 1995 Peter Wemm <peter@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, is permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice immediately at the beginning of the file, without modification,
9 .\" this list of conditions, and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. This work was done expressly for inclusion into FreeBSD. Other use
14 .\" is permitted provided this notation is included.
15 .\" 4. Absolutely no warranty of function or purpose is made by the author
17 .\" 5. Modifications may be freely made to this file providing the above
18 .\" conditions are met.
22 .\" The following requests are required for all man pages.
33 .Fn setproctitle "const char *fmt" "..."
37 library routine sets the process title that appears on the
41 The title is set from the executable's name, followed by the
44 style expansion of the arguments as specified by the
49 argument begins with a
51 character, the executable's name is skipped.
55 is NULL, the process title is restored.
57 To set the title on a daemon to indicate its activity:
58 .Bd -literal -offset indent
59 setproctitle("talking to %s", inet_ntoa(addr));
71 is implicitly non-standard.
72 Other methods of causing the
74 command line to change, including copying over the argv[0] string are
75 also implicitly non-portable.
76 It is preferable to use an operating system
81 Unfortunately, it is possible that there are other calling conventions
84 although none have been found by the author as yet.
85 This is believed to be
86 the predominant convention.
88 It is thought that the implementation is compatible with other systems,
99 Other operating systems have
103 .An Peter Wemm Aq peter@FreeBSD.org
104 stole the idea from the
107 .An Eric Allman Aq eric@sendmail.org .
109 Never pass a string with user-supplied data as a format without using
111 An attacker can put format specifiers in the string to mangle your stack,
112 leading to a possible security hole.
113 This holds true even if the string was built using a function like
115 as the resulting string may still contain user-supplied conversion specifiers
116 for later interpolation by
119 Always use the proper secure idiom:
121 .Dl setproctitle("%s", string);