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.Nm lwp_getname 39.Nd set or retrieve the lwp name that shows up in ps 40.Sh LIBRARY 41.Lb libc 42.Sh SYNOPSIS 43.In sys/lwp.h 44.Ft int 45.Fn lwp_setname "lwpid_t tid" "const char *name" 46.Ft int 47.Fn lwp_getname "lwpid_t tid" "char *name" "size_t len" 48.Sh DESCRIPTION 49The 50.Fn lwp_setname 51system call sets the lwp name. 52The lwp is in the process calling this system call, 53and the lwp is specified by 54.Fa tid . 55If the 56.Fa name 57is 58.Dv NULL , 59the lwp name will be set to the process name, 60which is the default name of the lwp. 61The 62.Fa name 63will be truncated, 64if it is longer than 65.Dv MAXCOMLEN . 66.Pp 67The 68.Fn lwp_getname 69system call gets the lwp name, storing it in the supplied 70buffer up to (len - 1) characters plus the terminator. 71The buffer will always be terminated. 72.Sh RETURN VALUES 73This system call returns \-1 on error and 740 upon successful completion. 75.Sh ERRORS 76The 77.Fn lwp_setname 78system call will fail if: 79.Bl -tag -width Er 80.It Bq Er EFAULT 81The 82.Fa name 83parameter is outside the process's allocated address space. 84.El 85.Sh SEE ALSO 86.Xr lwp_create 2 , 87.Xr setproctitle 3 88.Sh HISTORY 89The 90.Fn lwp_setname 91function first appeared in 92.Dx 4.3 . 93