ref: 737387eeb5d7d313963790334014648e6b896f8e
parent: e78b5e27f582a692b81369be4614d0a7b8eee9cb
author: sirjofri <sirjofri@sirjofri.de>
date: Sun Aug 31 06:47:29 EDT 2025
adds man page
--- /dev/null
+++ b/README
@@ -1,0 +1,54 @@
+
+ NETGRAPH(1) NETGRAPH(1)
+
+ NAME
+ netgraph - generate a network graph of the Plan 9 system
+
+ SYNOPSIS
+ netgraph [ -ip ] [ -s systuples ] [ -n ipnettuples ]
+
+ DESCRIPTION
+ Netgraph generates a network graph of the Plan 9 system
+ based on all data found by the connection service.
+
+ It reads requests from stdin. Each line has to be one
+ request tuple in the format type=what, for example
+ sys=cirno. Currently valid requests are:
+
+ for systems:
+ sys, ip, dom, ipgw.
+
+ for ipnets:
+ ipnet.
+
+ Netgraph will try to find relevant fields for each system
+ and ipnet. You can use the -s and -n parameters to adjust
+ the default list of fields.
+
+ In addition to that, netgraph supports the following parame-
+ ters:
+
+ -i By default, netgraph hides fields that are derived from
+ the ipnet in the system visualization. This flag can
+ be used to include all relevant ipnet values.
+
+ -p Netgraph outputs a PostScript file by default. This
+ flag pipes that output through ps2pdf with the proper
+ parameters set to have the correct page size. The out-
+ put format will be PDF.
+
+ -s systuples
+ The user can adjust the relevant fields to search for
+ by providing a comma separated list of field names.
+
+ -n ipnettuples
+ This is analog to -s, but for ipnets.
+
+ EXAMPLE
+ SOURCE
+ SEE ALSO
+ ndb(8), ps2pdf(1)
+
+ BUGS
+ Sure. Send patches.
+
--- a/mkfile
+++ b/mkfile
@@ -12,3 +12,8 @@
HFILES=dat.h fns.h
</sys/src/cmd/mkone
+
+README:V:
+ rfork n
+ bind . /sys/man/1
+ man 1 netgraph1 > $target
--- /dev/null
+++ b/netgraph1
@@ -1,0 +1,73 @@
+.TH NETGRAPH 1
+.SH NAME
+netgraph \- generate a network graph of the Plan 9 system
+.SH SYNOPSIS
+.B netgraph
+[
+.B -ip
+]
+[
+.B -s
+.I systuples
+]
+[
+.B -n
+.I ipnettuples
+]
+.SH DESCRIPTION
+.I Netgraph
+generates a network graph of the Plan 9 system based on all data found by the connection service.
+.PP
+It reads requests from stdin.
+Each line has to be one request tuple in the format
+.IR type=what ,
+for example
+.IR sys=cirno .
+Currently valid requests are:
+.IP "for systems:"
+.IR sys ", " ip ", " dom ", "
+.IR ipgw .
+.IP "for ipnets:"
+.IR ipnet .
+.PP
+.I Netgraph
+will try to find relevant fields for each system and ipnet.
+You can use the
+.I -s
+and
+.I -n
+parameters to adjust the default list of fields.
+.PP
+In addition to that,
+.I netgraph
+supports the following parameters:
+.IP -i
+By default,
+.I netgraph
+hides fields that are derived from the
+.I ipnet
+in the system visualization.
+This flag can be used to include all relevant
+.I ipnet
+values.
+.IP -p
+.I Netgraph
+outputs a PostScript file by default.
+This flag pipes that output through
+.I ps2pdf
+with the proper parameters set to have the correct page size.
+The output format will be PDF.
+.IP "-s systuples"
+The user can adjust the relevant fields to search for by providing a comma separated list of field names.
+.IP "-n ipnettuples"
+This is analog to
+.IR -s ,
+but for
+.IR ipnets .
+.SH EXAMPLE
+.SH SOURCE
+.SH SEE ALSO
+.IR ndb (8),
+.IR ps2pdf (1)
+.SH BUGS
+Sure. Send patches.
--
⑨