xref: /dragonfly/lib/libc/sys/lwp_setname.2 (revision 55358b98)
1.\" Copyright (c) 2015 The DragonFly Project.  All rights reserved.
2.\"
3.\" This code is derived from software contributed to The DragonFly Project
4.\" by Sepherosa Ziehau <sepherosa@gmail.com>.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\"
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in
14.\"    the documentation and/or other materials provided with the
15.\"    distribution.
16.\" 3. Neither the name of The DragonFly Project nor the names of its
17.\"    contributors may be used to endorse or promote products derived
18.\"    from this software without specific, prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
24.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.Dd November 19, 2015
34.Dt LWP_SETNAME 2
35.Os
36.Sh NAME
37.Nm lwp_setname
38.Nd Change lwp name
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
42.In unistd.h
43.Ft int
44.Fn lwp_setname "lwpid_t tid" "const char *name"
45.Sh DESCRIPTION
46The
47.Fn lwp_setname
48system call sets the lwp name.
49The lwp is in the process calling this system call,
50and the lwp is specified by
51.Fa tid .
52If the
53.Fa name
54is
55.Dv NULL ,
56the lwp name will be set to the process name,
57which is the default name of the lwp.
58The
59.Fa name
60will be truncated,
61if it is longer than
62.Dv MAXCOMLEN .
63.Sh RETURN VALUES
64This system call returns \-1 on error and
650 upon successful completion.
66.Sh ERRORS
67The
68.Fn lwp_setname
69system call will fail if:
70.Bl -tag -width Er
71.It Bq Er EFAULT
72The
73.Fa name
74parameter is outside the process's allocated address space.
75.El
76.Sh SEE ALSO
77.Xr lwp_create 2
78.Xr setproctitle 3
79.Sh HISTORY
80The
81.Fn lwp_setname
82function first appeared in
83.Dx 4.3 .
84