d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b06b097805
freebsd-dev/lib/libc/gen/ftok.3

86 lines
2.8 KiB
Groff
Raw Normal View History

Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.\" Copyright (c) 1994 SigmaSoft, Th. Lockert <tholo@sigmasoft.com>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Dd June 24, 1994
.Os
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlines in mdoc(7) - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexy M. Zelkin <phantom@cris.net>
1999-08-15 09:51:25 +00:00
.Dt FTOK 3
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Sh NAME
.Nm ftok
Another round of spelling fixes.
1996-01-30 18:13:11 +00:00
.Nd create IPC identifier from path name
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/types.h
.In sys/ipc.h
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Ft key_t
FIxed arg types (mostly missing consts) in synopsis.
1997-03-19 00:58:07 +00:00
.Fn ftok "const char *path" "int id"
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Sh DESCRIPTION
.Bf -symbolic
This function is available from the compatibility library, libcompat.
.Ef
The
.Fn ftok
function attempts to create a unique key suitable for use with the
Correct the xref for msgctl: msgctl(2) -> msgctl(3)
1996-02-12 07:06:23 +00:00
.Xr msgget 3 ,
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Xr semget 2
and
.Xr shmget 2
functions given the
.Fa path
of an existing file and a user-selectable
.Fa id .
.Pp
The specified
.Fa path
must specify an existing file that is accessible to the calling process
or the call will fail. Also, note that links to files will return the
same key, given the same
.Fa id .
.Sh RETURN VALUES
The
.Fn ftok
function will return -1 if
.Fa path
does not exist or if it cannot be accessed by the calling process.
.Sh SEE ALSO
.Xr semget 2 ,
Correct the xref for msgctl: msgctl(2) -> msgctl(3)
1996-02-12 07:06:23 +00:00
.Xr shmget 2 ,
.Xr msgget 3
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Sh HISTORY
The
.Fn ftok
Minor corrections. The second parameter is actually of type int (though only char will be used), and our implementation is not really worse than the SysV one, so there's no need to claim so in the BUGS section.
1996-06-03 10:40:39 +00:00
function originates with System V and is typically used by programs
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
that use the System V IPC routines.
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq
1998-03-19 07:34:22 +00:00
.Sh AUTHORS
.An Thorsten Lockert Aq tholo@sigmasoft.com
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Sh BUGS
Minor corrections. The second parameter is actually of type int (though only char will be used), and our implementation is not really worse than the SysV one, so there's no need to claim so in the BUGS section.
1996-06-03 10:40:39 +00:00
The returned key is computed based on the device minor number and inode of the
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
specified
.Fa path
Minor corrections. The second parameter is actually of type int (though only char will be used), and our implementation is not really worse than the SysV one, so there's no need to claim so in the BUGS section.
1996-06-03 10:40:39 +00:00
in combination with the lower 8 bits of the given
Added function and man page for ftok(3), used in conjunction with the so-called "System V IPC". Submitted by: jbeukema@HK.Super.Net (John Beukema) Obtained from: Th. Lockert <tholo@sigmasoft.com>, via NetBSD
1995-05-01 08:53:21 +00:00
.Fa id .
delete doubled words, e.g.: "the the" -> "the"
1996-10-05 22:27:30 +00:00
Thus it is quite possible for the routine to return duplicate keys.
Reference in New Issue Copy Permalink