aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2025-10-09 07:07:32 -0700
committerGarrett D'Amore <garrett@damore.org>2025-10-09 07:07:32 -0700
commit9720d7031259dbfb775b9a251d735f1574339a92 (patch)
treef45809176d51ce27551e450a82a274e555d5b1d6 /docs
parentbdf85dd692d803b7b2fc793f1c7723f9874bfcdb (diff)
downloadnng-9720d7031259dbfb775b9a251d735f1574339a92.tar.gz
nng-9720d7031259dbfb775b9a251d735f1574339a92.tar.bz2
nng-9720d7031259dbfb775b9a251d735f1574339a92.zip
Remove the IPC option asciidoc, they are already moved into the IPC transport markdown.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_ipc_options.5.adoc110
-rw-r--r--docs/man/nng_options.5.adoc1
2 files changed, 0 insertions, 111 deletions
diff --git a/docs/man/nng_ipc_options.5.adoc b/docs/man/nng_ipc_options.5.adoc
deleted file mode 100644
index 79a302e8..00000000
--- a/docs/man/nng_ipc_options.5.adoc
+++ /dev/null
@@ -1,110 +0,0 @@
-= nng_ipc_options(5)
-//
-// Copyright 2023 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-// Copyright 2019 Devolutions <info@devolutions.net>
-//
-// This document is supplied under the terms of the MIT License, a
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt). A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_ipc_options - IPC-specific options
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-#define NNG_OPT_IPC_PEER_GID "ipc:peer-gid"
-#define NNG_OPT_IPC_PEER_PID "ipc:peer-pid"
-#define NNG_OPT_IPC_PEER_UID "ipc:peer-uid"
-#define NNG_OPT_IPC_PEER_ZONEID "ipc:peer-zoneid"
-#define NNG_OPT_IPC_PERMISSIONS "ipc:permissions"
-----
-
-== DESCRIPTION
-
-This page documents the various standard options that can be set or
-retrieved on objects using IPC.
-
-The option names should always be used by their symbolic definitions.
-
-In the following list of options, the name of the option is supplied,
-along with the data type of the underlying value.
-
-Some options are only meaningful or supported in certain contexts, or may
-have other access restrictions.
-An attempt has been made to include details about such restrictions in the
-description of the option.
-
-NOTE: The availability of the following options is platform-specific,
-as the implementations of IPC are quite different on Windows and POSIX systems.
-
-[[NNG_OPT_IPC_PERMISSIONS]]((`NNG_OPT_IPC_PERMISSIONS`))::
-(`int`)
-This write-only option may be applied to a listener to configure the
-permissions that are used on the UNIX domain socket created by that listener.
-This property is only supported on POSIX systems.
-The value is of type `int`, representing the normal permission bits
-on a file, such as `0600` (typically meaning read-write to the owner, and
-no permissions for anyone else.)
-The default is system-specific, most often `0644`.
-+
-IMPORTANT: Not all systems validate these permissions.
-In particular, illumos and Solaris are known to ignore these permission
-settings when connecting.
-+
-NOTE: Normally both read and write permission will be necessary for a
-peer dialer to connect.
-See your system documentation for UNIX domain sockets for more information.
-+
-NOTE: The _umask_ of the process is *not* applied to these bits.
-+
-TIP: The best practice for limiting access is to place the socket in a
-directory writable only by the server, and only readable and searchable
-by clients.
-All mainstream POSIX systems will fail to permit a client to connect
-to a socket located in a directory for which the client lacks search (execute)
-permission.
-
-[[NNG_OPT_IPC_SECURITY_DESCRIPTOR]]((`NNG_OPT_IPC_SECURITY_DESCRIPTOR`))::
-(`PSECURITY_DESCRIPTOR`)
-TODO: REWRITE THIS TO REFLECT new nng_listener_get_security_security_descriptor.
-This write-only option may be used on listeners on Windows platforms to
-configure the `SECURITY_DESCRIPTOR` that is used when creating the underlying
-named pipe.
-The value is a pointer, `PSECURITY_DESCRIPTOR`, and may only be
-applied to listeners that have not been started yet.
-
-=== Common Platform Specific Options
-
-The following options are supported by this transport when the underlying platform supports them:
-
-* xref:nng_options.5.adoc#NNG_OPT_PEER_GID[`NNG_OPT_PEER_GID`] (also available as `NNG_OPT_IPC_PEER_GID`)
-* xref:nng_options.5.adoc#NNG_OPT_PEER_PID[`NNG_OPT_PEER_PID`] (also available as `NNG_OPT_IPC_PEER_PID`)
-* xref:nng_options.5.adoc#NNG_OPT_PEER_UID[`NNG_OPT_PEER_UID`] (also available as `NNG_OPT_IPC_PEER_UID`)
-* xref:nng_options.5.adoc#NNG_OPT_PEER_ZONEID[`NNG_OPT_PEER_ZONEID`] (also available as `NNG_OPT_IPC_PEER_ZONEID`)
-
-=== Inherited Options
-
-Generally, the following option values are also available when appropriate for the context:
-
-* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`]
-* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`]
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_dialer_get.3.adoc[nng_dialer_get(3)],
-xref:nng_dialer_set.3.adoc[nng_dialer_set(3)],
-xref:nng_listener_get.3.adoc[nng_listener_get(3)],
-xref:nng_listener_set.3.adoc[nng_listener_set(3)],
-xref:nng_pipe_get.3.adoc[nng_pipe_get(3)],
-xref:nng_options.5.adoc[nng_options(5)]
-xref:nng.7.adoc[nng(7)],
-xref:nng_ipc.7.adoc[nng_ipc(7)]
diff --git a/docs/man/nng_options.5.adoc b/docs/man/nng_options.5.adoc
index 8a8e43ec..3e67ba9c 100644
--- a/docs/man/nng_options.5.adoc
+++ b/docs/man/nng_options.5.adoc
@@ -232,7 +232,6 @@ xref:nng_listener_set.3.adoc[nng_listener_set(3)],
xref:nng_pipe_get.3.adoc[nng_pipe_get(3)],
xref:nng_socket_get.3.adoc[nng_socket_get(3)],
xref:nng_socket_set.3.adoc[nng_socket_set(3)],
-xref:nng_ipc_options.5.adoc[nng_ipc_options(5)],
xref:nng_tcp_options.5.adoc[nng_tcp_options(5)],
xref:nng_tls_options.5.adoc[nng_tls_options(5)],
xref:nng.7.adoc[nng(7)]