syscall documentation (3)

syscall documentation (3)

[Andries.Brouwer]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain, Size: 1577 bytes --]

The next new page is tkill.2

Comments welcome.
Andries
aeb@cwi.nl

-----------------------------------
NAME
       tkill - send a signal to a single process

SYNOPSIS
       #include <sys/types.h>
       #include <linux/unistd.h>

       _syscall2(int, tkill, pid_t, tid, int, sig)

       int tkill(pid_t tid, int sig);

DESCRIPTION
       The tkill system call is analogous to kill(2), except when
       the specified process is part of a thread  group  (created
       by specifying the CLONE_THREAD flag in the call to clone).
       Since all the processes in a thread group  have  the  same
       PID,  they  cannot  be  individually  signalled with kill.
       With tkill, however, one can address each process  by  its
       unique TID.

RETURN VALUE
       On  success,  zero  is returned. On error, -1 is returned,
       and errno is set appropriately.

ERRORS
       EINVAL An invalid TID or signal was specified.

       ESRCH  No process with the specified TID exists.

       EPERM  The caller did not have permission to send the sig­
              nal  to  the specified process. For a process to be
              allowed to send a signal, it must either have  root
              privileges,  or  its real or effective user ID must
              be equal to the real or saved  set-user-ID  of  the
              receiving process.

CONFORMING TO
       tkill is Linux specific and should not be used in programs
       that are intended to be portable.

SEE ALSO
       gettid(2), kill(2)

Linux 2.4.20                2003-02-01                   TKILL(2)

Re: syscall documentation (3)

[Christoph Hellwig]

On Thu, Feb 06, 2003 at 09:09:24PM +0100, Andries.Brouwer@cwi.nl wrote:
> The next new page is tkill.2
> 
> Comments welcome.
> Andries
> aeb@cwi.nl
> 
> -----------------------------------
> NAME
>        tkill - send a signal to a single process

Shouldn't kill and tkill be in one manpoage that documents both?

Re: syscall documentation (3)

[Andries.Brouwer]

> Shouldn't kill and tkill be in one manpage that documents both?

Perhaps, but I think having them separate is better:
- killpg is also separate
- separate pages are easy: one can write "conforming to POSIX"
  in one, and "Linux specific" in the other. Merging gives a
  messy page
- the audiences will differ, I think

But I put a "SEE ALSO" in kill.2 referring to tkill.2.

Andries