lucaspalomodevelop/core
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/core.git synced 2026-03-15 17:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

interfaces: add manual page for ifctl; closes #5631

Browse Source
This commit is contained in:
Franco Fichtner 2022-03-18 09:20:09 +01:00
parent cea2768c71
commit 56bd1c33c2
2 changed files with 89 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
plist
View File

@ -1734,6 +1734,7 @@
/usr/local/sbin/ping_hosts.sh
/usr/local/sbin/pluginctl
/usr/local/share/man/man8/configctl.8.gz
/usr/local/share/man/man8/ifctl.8.gz
/usr/local/share/man/man8/opnsense-beep.8.gz
/usr/local/share/man/man8/opnsense-importer.8.gz
/usr/local/share/man/man8/opnsense-installer.8.gz

88
src/man/man8/ifctl.8 Normal file
View File

@ -0,0 +1,88 @@
.\"
.\" Copyright (c) 2022 Franco Fichtner <franco@opnsense.org>
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
.\"
.Dd March 18, 2022
.Dt IFCTL 8
.Os
.Sh NAME
.Nm ifctl
.Nd Interface helper utility
.Sh SYNOPSIS
.Nm
.Op Fl i Ar device
.Op Fl nprs
.Op Fl d
.Op Fl a Ar data
.Sh DESCRIPTION
The
.Nm
utility will display or modify network device related data used by dynamic
connections.
If neither
.Sq Fl d
or
.Sq Fl a
are given the current data is returned instead of modifying it.
.Pp
The options are as follows:
.Bl -tag -width ".Fl i Ar interface" -offset indent
.It Fl 4
Use IPv4 mode.
This is the default.
.It Fl 6
Use IPv6 mode.
.It Fl a
Append data to the currently selected device information.
The option can be used multiple times in the same command invoke
to append data at once.
Note that
.Sq Fl d
will be executed first when given in the same command invoke.
.It Fl d
Delete the data of the currently selected device information.
.It Fl i Ar device
Select the
.Ar device
to operate on.
If none was given
.Nm
list the available devices.
.It Fl n
Use name server mode.
This is the default.
.It Fl p
Use prefix delegation mode.
.It Fl r
Use router mode.
.It Fl s
Use search domain mode.
.It Fl V
Set debug mode for shell script output.
.El
.Sh EXIT STATUS
.Ex -std
.Sh AUTHORS
.An Franco Fichtner Aq Mt franco@opnsense.org