doc.go 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. // Package netlink provides low-level access to Linux netlink sockets.
  2. //
  3. // If you have any questions or you'd like some guidance, please join us on
  4. // Gophers Slack (https://invite.slack.golangbridge.org) in the #networking
  5. // channel!
  6. //
  7. //
  8. // Network namespaces
  9. //
  10. // This package is aware of Linux network namespaces, and can enter different
  11. // network namespaces either implicitly or explicitly, depending on
  12. // configuration. The Config structure passed to Dial to create a Conn controls
  13. // these behaviors. See the documentation of Config.NetNS for details.
  14. //
  15. //
  16. // Debugging
  17. //
  18. // This package supports rudimentary netlink connection debugging support.
  19. // To enable this, run your binary with the NLDEBUG environment variable set.
  20. // Debugging information will be output to stderr with a prefix of "nl:".
  21. //
  22. // To use the debugging defaults, use:
  23. //
  24. // $ NLDEBUG=1 ./nlctl
  25. //
  26. // To configure individual aspects of the debugger, pass key/value options such
  27. // as:
  28. //
  29. // $ NLDEBUG=level=1 ./nlctl
  30. //
  31. // Available key/value debugger options include:
  32. //
  33. // level=N: specify the debugging level (only "1" is currently supported)
  34. package netlink
  35. //go:generate dot netlink.dot -T svg -o netlink.svg