Skip to content
This repository was archived by the owner on Feb 26, 2023. It is now read-only.

Commit a41cf12

Browse files
committed
docs: Add dhclient related documentation (#9)
1 parent 1baf4c8 commit a41cf12

File tree

1 file changed

+43
-5
lines changed

1 file changed

+43
-5
lines changed

README.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Management daemons and CLIs for the ISC DHCP server and client.
1212
In a similar way, `godhcpd` is built of multiple components. The components are:
1313

1414
- `dhcpdd`, an ISC DHCP server management daemon with a gRPC interface
15-
- `dhclientd`, an ISC DHCP client management daemon with a gRPC interface (TBD)
15+
- `dhclientd`, an ISC DHCP client management daemon with a gRPC interface
1616
- `dhcpdctl`, a CLI for `dhcpdd`
17-
- `dhclientctl`, a CLI for `dhclientd` (TBD)
17+
- `dhclientctl`, a CLI for `dhclientd`
1818

1919
`dhcpdd` bundles the `dhcpd` and `dhclient` binaries into it's own binary and extracts them on startup, so there is no need to install the ISC DHCP server and client manually.
2020

@@ -50,7 +50,23 @@ Flags:
5050

5151
#### `dhclientd`
5252

53-
(TBD)
53+
You may also set the flags by setting env variables in the format `DHCLIENTD_[FLAG]` (i.e. `DHCLIENTD_DHCLIENTD_CONFIGFILE=examples/dhclientd.yaml`) or by using a [configuration file](examples/dhclientd.yaml).
54+
55+
```bash
56+
% dhclientd --help
57+
dhclientd is the ISC DHCP client management daemon.
58+
59+
Find more information at:
60+
https://pojntfx.github.io/godhcpd/
61+
62+
Usage:
63+
dhclientd [flags]
64+
65+
Flags:
66+
-f, --dhclientd.configFile string Configuration file to use.
67+
-l, --dhclientd.listenHostPort string TCP listen host:port. (default "localhost:1241")
68+
-h, --help help for dhclientd
69+
```
5470

5571
### Client CLIs
5672

@@ -71,7 +87,7 @@ Usage:
7187
dhcpdctl [command]
7288

7389
Available Commands:
74-
apply Apply an dhcp server
90+
apply Apply a dhcp server
7591
delete Delete one or more dhcp server(s)
7692
get Get one or all dhcp server(s)
7793
help Help about any command
@@ -84,7 +100,29 @@ Use "dhcpdctl [command] --help" for more information about a command.
84100

85101
#### `dhclientctl`
86102

87-
(TBD)
103+
You may also set the flags by setting env variables in the format `DHCLIENT_[FLAG]` (i.e. `DHCLIENT_DHCLIENT_CONFIGFILE=examples/dhclient.yaml`) or by using a [configuration file](examples/dhclient.yaml).
104+
105+
```bash
106+
% dhclientctl --help
107+
dhclientctl manages dhclientd, the ISC DHCP client management daemon.
108+
109+
Find more information at:
110+
https://pojntfx.github.io/godhcpd/
111+
112+
Usage:
113+
dhclientctl [command]
114+
115+
Available Commands:
116+
apply Apply a dhcp client
117+
delete Delete one or more dhcp client(s)
118+
get Get one or all dhcp client(s)
119+
help Help about any command
120+
121+
Flags:
122+
-h, --help help for dhclientctl
123+
124+
Use "dhclientctl [command] --help" for more information about a command.
125+
```
88126

89127
## License
90128

0 commit comments

Comments
 (0)