xref: /netbsd-src/lib/libc/gen/setproctitle.3 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\"
2.\" Copyright (c) 1994 Christopher G. Demetriou
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, 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. All advertising materials mentioning features or use of this software
14.\"    must display the following acknowledgement:
15.\"      This product includes software developed by Christopher G. Demetriou.
16.\" 3. The name of the author may not be used to endorse or promote products
17.\"    derived from this software without specific prior written permission
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\"	$Id: setproctitle.3,v 1.1 1994/04/14 03:13:42 cgd Exp $
31.\"
32.Dd "April 13, 1994"
33.Dt SETPROCTITLE 3
34.Os NetBSD 0.9a
35.Sh NAME
36.Nm setproctitle
37.Nd set process title
38.Sh SYNOPSIS
39.Fd #include <stdlib.h>
40.Ft void
41.Fn setproctitle "const char *fmt" "..."
42.Sh DESCRIPTION
43The
44.Fn setproctitle
45function sets the invoking process's title.
46The process title is set to the last component of the program
47name, followed by a colon and the formatted string specified
48by
49.Va fmt .
50If
51.Va fmt
52is NULL, the colon and formatted string are omitted.
53The length of a process title is limited to 2048 bytes.
54.Sh EXAMPLES
55Set the process title to the program name, with no further information:
56.Bd -literal -offset indent
57setproctitle(NULL);
58.Ed
59.Pp
60Set the process title to the program name, an informational string,
61and the process id:
62.Bd -literal -offset indent
63setproctitle("foo! (%s)", getpid());
64.Ed
65.Sh SEE ALSO
66.Xr ps 1 ,
67.Xr w 1 ,
68.Xr printf 3
69.Sh HISTORY
70The
71.Fn setproctitle
72function first appeared in
73.Nx 0.9a .
74