pmlag

commit 65a06ddfb0c238ad6e7cfa5f0b9b13ddcc738e4c
parent cc1a72352763ee1582bb8baa65e486de08355993
Author: Yersa Nordman <yersa@finwo.nl>
Date:   Mon, 13 Mar 2023 23:57:34 +0100

Added options section in manpage/readme

Diffstat:
M
README.md
 | 
17
+++++++++++++++++
M
manpage.1.md
 | 
24
++++++++++++++++--------
M
pmlag.1
 | 
37
+++++++++++++++++++++++++++++++------
M
pmlag.html
 | 
38
+++++++++++++++++++++++++++++++-------

4 files changed, 95 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@ NAME
 
 pmlag - Poor man's link aggregator
 
+pmlag is a tool for bonding network interfaces together when the hardware on
+the other side of the cable(s) doesn't support it.
+
 COMPILATION
 ===========
 
@@ -19,6 +22,20 @@ SYNOPSIS
 
 `pmlag [options]`
 
+OPTIONS
+=======
+
+Option | Description |
+ --- | ---
+‐c <file> | Select the config file to use (default: /etc/pmlag/pmlag.ini)
+|
+‐h | ‐‐help | Show basic usage of the utility
+
+CONFIGURATION
+=============
+
+TODO
+
 LICENSE
 =======
 
diff --git a/manpage.1.md b/manpage.1.md
@@ -5,20 +5,28 @@ NAME
 
 ${NAME} - Poor man's link aggregator
 
-COMPILATION
-===========
-
-This library makes use of [dep](https://github.com/finwo/dep) to manage it's
-dependencies and exports.
-
-To build, first run `dep install` from the root of the repository, after which
-you can run `make` to build the project.
+${NAME} is a tool for bonding network interfaces together when the hardware on
+the other side of the cable(s) doesn't support it.
 
 SYNOPSIS
 ========
 
 `${NAME} [options]`
 
+OPTIONS
+=======
+
+Option | Description |
+ --- | ---
+‐c <file> | Select the config file to use (default: /etc/pmlag/pmlag.ini)
+|
+‐h | ‐‐help | Show basic usage of the utility
+
+CONFIGURATION
+=============
+
+TODO
+
 LICENSE
 =======
 
diff --git a/pmlag.1 b/pmlag.1
@@ -1,3 +1,4 @@
+'\" t
 .\" Automatically generated by Pandoc 2.17.1.1
 .\"
 .\" Define V font for inline verbatim, using C font in formats
@@ -19,16 +20,40 @@
 .SH NAME
 .PP
 pmlag - Poor man\[cq]s link aggregator
-.SH COMPILATION
 .PP
-This library makes use of dep (https://github.com/finwo/dep) to manage
-it\[cq]s dependencies and exports.
-.PP
-To build, first run \f[V]dep install\f[R] from the root of the
-repository, after which you can run \f[V]make\f[R] to build the project.
+pmlag is a tool for bonding network interfaces together when the
+hardware on the other side of the cable(s) doesn\[cq]t support it.
 .SH SYNOPSIS
 .PP
 \f[V]pmlag [options]\f[R]
+.SH OPTIONS
+.PP
+.TS
+tab(@);
+lw(35.0n) lw(35.0n).
+T{
+Option
+T}@T{
+Description
+T}
+_
+T{
+\[hy]c <file>
+T}@T{
+Select the config file to use (default: /etc/pmlag/pmlag.ini)
+T}
+T{
+T}@T{
+T}
+T{
+\[hy]h | \[hy]\[hy]help
+T}@T{
+Show basic usage of the utility
+T}
+.TE
+.SH CONFIGURATION
+.PP
+TODO
 .SH LICENSE
 .PP
 This program itself is licensed under the MIT license:
diff --git a/pmlag.html b/pmlag.html
@@ -164,15 +164,39 @@
 </header>
 <h1 id="name">NAME</h1>
 <p>pmlag - Poor man’s link aggregator</p>
-<h1 id="compilation">COMPILATION</h1>
-<p>This library makes use of <a
-href="https://github.com/finwo/dep">dep</a> to manage it’s dependencies
-and exports.</p>
-<p>To build, first run <code>dep install</code> from the root of the
-repository, after which you can run <code>make</code> to build the
-project.</p>
+<p>pmlag is a tool for bonding network interfaces together when the
+hardware on the other side of the cable(s) doesn’t support it.</p>
 <h1 id="synopsis">SYNOPSIS</h1>
 <p><code>pmlag [options]</code></p>
+<h1 id="options">OPTIONS</h1>
+<table>
+<colgroup>
+<col style="width: 50%" />
+<col style="width: 50%" />
+</colgroup>
+<thead>
+<tr class="header">
+<th>Option</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
+<td>‐c &lt;file&gt;</td>
+<td>Select the config file to use (default: /etc/pmlag/pmlag.ini)</td>
+</tr>
+<tr class="even">
+<td></td>
+<td></td>
+</tr>
+<tr class="odd">
+<td>‐h | ‐‐help</td>
+<td>Show basic usage of the utility</td>
+</tr>
+</tbody>
+</table>
+<h1 id="configuration">CONFIGURATION</h1>
+<p>TODO</p>
 <h1 id="license">LICENSE</h1>
 <p>This program itself is licensed under the MIT license:</p>
 <p>Copyright 2023 finwo</p>