diff --git a/Documentation.md b/Documentation.md index 3b18576..99a811c 100644 --- a/Documentation.md +++ b/Documentation.md @@ -1,25 +1,33 @@ ## Variables +### Addresses to exchange: +- var **NewIP** net.IP +- var **NewMAC** net.HardwareAddr +- var **OldIP** net.IP +- var **OldMAC** net.HardwareAddr +### In-/Output to VM and network: +- var **NetReader** io.Reader +- var **NetWriter** io.Writer +- var **VmReader** io.Reader +- var **VmWriter** io.Writer + +### DHCP variables: - var **DHCPCandidate** net.IP +- var **DHCPDNSIP** net.IP - var **DHCPIP** net.IP - var **DHCPMAC** net.HardwareAddr - var **DHCPMask** []byte +- var **DHCPRouterIP** net.IP - var **DHCPState** dhcp4.MessageType -- var **DNSIP** net.IP +- var **DHCPXId** []byte + +### User-provided variables: - var **Hostname** string -- var **NetReader** io.Reader -- var **NetWriter** io.Writer -- var **NewIP** net.IP -- var **NewMAC** net.HardwareAddr -- var **OldIP** net.IP -- var **OldMAC** net.HardwareAddr - var **Passthrough** bool -- var **RouterIP** net.IP -- var **UId** string -- var **VmReader** io.Reader -- var **VmWriter** io.Writer - var **Wireshark** bool -- var **XId** []byte + +### UId used as host name: +- var **UId** string ## Functions