stubbing pdsh

pdsh/docs.go

@@ -1,16 +1,27 @@
 /*
-Package pdsh (!! WIP !!) provides PDSH-compatible functionality for parsing group files.
+Package pdsh (!! WIP !!) provides PDSH-compatible functionality for parsing group/gender/etc. files/sources.
 
-Note that this library will *only* source and parse PDSH-compatible host/group files,
+Note that this library will *only* generate the host list/etc.,
 it will not actually connect to anything.
 It simply provides ways of returning lists of hosts using generation rules/patterns.
+Said another way, it does not implement any of PDSH's "rcmd" modules, only the "misc" modules.
 
-Currently, the only supported PDSH module is `misc/dshgroup` but additional/all other
+(As a hint, you can implement SSH connections via [golang.org/x/crypto/ssh] in goroutine'd functions
+using this package to generate the target addresses, etc.)
+
+Currently, the only supported PDSH module is misc/dshgroup (as [r00t2.io/sysutils/pdsh/dshgroup]) but additional/all other
 host list modules are planned.
 
-For details, see:
+This package deviates slightly from PDSH in some areas; allowing for more loose or more strict behavior occasionally.
+Whenever a deviation is offered, this package allows for configuring the generator to behave exactly like PDSH instead
+(if the deviating behavior is enabled by default).
 
-  - https://github.com/chaos/pdsh/
-  - https://github.com/chaos/pdsh/blob/master/doc/pdsh.1.in
+For details, see the [chaos/pdsh GitHub], the associated [MAN page source], and/or the [rendered MAN page] (via ManKier).
+You may also want to see the ManKier rendered MAN pages for the [pdsh package].
+
+[chaos/pdsh GitHub]: https://github.com/chaos/pdsh/
+[MAN page source]: https://github.com/chaos/pdsh/blob/master/doc/pdsh.1.in
+[rendered MAN page]: https://www.mankier.com/1/pdsh
+[pdsh package]: https://www.mankier.com/package/pdsh
 */
 package pdsh