summaryrefslogtreecommitdiff
path: root/man3/ftok.3
diff options
context:
space:
mode:
authorMichael Kerrisk <mtk.manpages@gmail.com>2007-04-12 22:42:49 +0000
committerMichael Kerrisk <mtk.manpages@gmail.com>2007-04-12 22:42:49 +0000
commitc13182efa3b3d77f2563034c8212c0ca798243ca (patch)
treee7652b26018b7c22cd6a4e4b41404dfaab911303 /man3/ftok.3
parent4174ff5658082832c2ed511720f18881b3a80a34 (diff)
Wrapped long lines, wrapped at sentence boundaries; stripped trailing
white space.
Diffstat (limited to 'man3/ftok.3')
-rw-r--r--man3/ftok.318
1 files changed, 11 insertions, 7 deletions
diff --git a/man3/ftok.3 b/man3/ftok.3
index 4410917cb..a8b18f0fd 100644
--- a/man3/ftok.3
+++ b/man3/ftok.3
@@ -8,7 +8,7 @@
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
-.\"
+.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
@@ -16,7 +16,7 @@
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
-.\"
+.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
@@ -24,7 +24,7 @@
.\" Changed data type of proj_id; minor fixes
.\" aeb: further fixes; added notes.
.\"
-.TH FTOK 3 2001-11-28 "Linux 2.4" "Linux Programmer's Manual"
+.TH FTOK 3 2001-11-28 "Linux 2.4" "Linux Programmer's Manual"
.SH NAME
ftok \- convert a pathname and a project identifier to a System V IPC key
.SH SYNOPSIS
@@ -55,12 +55,14 @@ or
The resulting value is the same for all pathnames that
name the same file, when the same value of
.I proj_id
-is used. The value returned should be different when the
+is used.
+The value returned should be different when the
(simultaneously existing) files or the project IDs differ.
.SH "RETURN VALUE"
On success the generated
.B key_t
-value is returned. On failure \-1 is returned, with
+value is returned.
+On failure \-1 is returned, with
.I errno
indicating the error as for the
.BR stat (2)
@@ -76,7 +78,8 @@ Today
.I proj_id
is an
.IR int ,
-but still only 8 bits are used. Typical usage has an ASCII character
+but still only 8 bits are used.
+Typical usage has an ASCII character
.IR proj_id ,
that is why the behaviour is said to be undefined when
.I proj_id
@@ -84,7 +87,8 @@ is zero.
.LP
Of course no guarantee can be given that the resulting
.B key_t
-is unique. Typically, a best effort attempt combines the given
+is unique.
+Typically, a best effort attempt combines the given
.I proj_id
byte, the lower 16 bits of the i\-node number, and the
lower 8 bits of the device number into a 32\-bit result.