aboutsummaryrefslogtreecommitdiffstats
path: root/man/man3/netlink.3
diff options
context:
space:
mode:
authorAlejandro Colomar <alx.manpages@gmail.com>2022-09-09 14:15:08 +0200
committerAlejandro Colomar <alx.manpages@gmail.com>2022-09-09 14:15:08 +0200
commit96e72ec1fbadd13cbcbc2b263540e4f5e9e09d7c (patch)
tree70686b943e33a6e939ad265acb7ddfef70b91f32 /man/man3/netlink.3
parent8f4ed6463206e8ede815c72085c7305dafc2e4fc (diff)
downloadman-pages-96e72ec1fbadd13cbcbc2b263540e4f5e9e09d7c.tar.gz
Revert "src.mk, All pages: Move man* to man/"
This reverts commit 70ac1c4785fc1e158ab2349a962dba2526bf4fbc. Link: <https://lore.kernel.org/linux-man/YxcV4h+Xn7cd6+q2@pevik/T/> Reported-by: Petr Vorel <pvorel@suse.cz> Reported-by: Jakub Wilk <jwilk@jwilk.net> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
Diffstat (limited to 'man/man3/netlink.3')
-rw-r--r--man/man3/netlink.387
1 files changed, 0 insertions, 87 deletions
diff --git a/man/man3/netlink.3 b/man/man3/netlink.3
deleted file mode 100644
index 564731102b..0000000000
--- a/man/man3/netlink.3
+++ /dev/null
@@ -1,87 +0,0 @@
-.\" This manpage copyright 1998 by Andi Kleen.
-.\"
-.\" SPDX-License-Identifier: GPL-1.0-or-later
-.\"
-.\" Based on the original comments from Alexey Kuznetsov
-.\" $Id: netlink.3,v 1.1 1999/05/14 17:17:24 freitag Exp $
-.\"
-.TH NETLINK 3 2014-03-20 "Linux man-pages (unreleased)"
-.SH NAME
-netlink \- Netlink macros
-.SH LIBRARY
-Standard C library
-.RI ( libc ", " \-lc )
-.SH SYNOPSIS
-.nf
-.B #include <asm/types.h>
-.B #include <linux/netlink.h>
-.PP
-.BI "int NLMSG_ALIGN(size_t " len );
-.BI "int NLMSG_LENGTH(size_t " len );
-.BI "int NLMSG_SPACE(size_t " len );
-.BI "void *NLMSG_DATA(struct nlmsghdr *" nlh );
-.BI "struct nlmsghdr *NLMSG_NEXT(struct nlmsghdr *" nlh ", int " len );
-.BI "int NLMSG_OK(struct nlmsghdr *" nlh ", int " len );
-.BI "int NLMSG_PAYLOAD(struct nlmsghdr *" nlh ", int " len );
-.fi
-.SH DESCRIPTION
-.I <linux/netlink.h>
-defines several standard macros to access or create a netlink datagram.
-They are similar in spirit to the macros defined in
-.BR cmsg (3)
-for auxiliary data.
-The buffer passed to and from a netlink socket should
-be accessed using only these macros.
-.TP
-.BR NLMSG_ALIGN ()
-Round the length of a netlink message up to align it properly.
-.TP
-.BR NLMSG_LENGTH ()
-Given the payload length,
-.IR len ,
-this macro returns the aligned length to store in the
-.I nlmsg_len
-field of the
-.IR nlmsghdr .
-.TP
-.BR NLMSG_SPACE ()
-Return the number of bytes that a netlink message with payload of
-.I len
-would occupy.
-.TP
-.BR NLMSG_DATA ()
-Return a pointer to the payload associated with the passed
-.IR nlmsghdr .
-.TP
-.\" this is bizarre, maybe the interface should be fixed.
-.BR NLMSG_NEXT ()
-Get the next
-.I nlmsghdr
-in a multipart message.
-The caller must check if the current
-.I nlmsghdr
-didn't have the
-.B NLMSG_DONE
-set\(emthis function doesn't return NULL on end.
-The
-.I len
-argument is an lvalue containing the remaining length
-of the message buffer.
-This macro decrements it by the length of the message header.
-.TP
-.BR NLMSG_OK ()
-Return true if the netlink message is not truncated and
-is in a form suitable for parsing.
-.TP
-.BR NLMSG_PAYLOAD ()
-Return the length of the payload associated with the
-.IR nlmsghdr .
-.SH STANDARDS
-These macros are nonstandard Linux extensions.
-.SH NOTES
-It is often better to use netlink via
-.I libnetlink
-than via the low-level kernel interface.
-.SH SEE ALSO
-.BR libnetlink (3),
-.BR netlink (7)