tsort(1): Add EXAMPLES section

Add a couple of simple examples to the man page

Approved by:	manpages (gbe@)
Differential Revision:	https://reviews.freebsd.org/D25883
This commit is contained in:
Fernando Apesteguía 2020-08-30 17:37:56 +00:00
parent 8e613cf5f3
commit 9051d94e9a

View File

@ -31,7 +31,7 @@
.\" @(#)tsort.1 8.3 (Berkeley) 4/1/94 .\" @(#)tsort.1 8.3 (Berkeley) 4/1/94
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd December 27, 2006 .Dd August 30, 2020
.Dt TSORT 1 .Dt TSORT 1
.Os .Os
.Sh NAME .Sh NAME
@ -75,6 +75,71 @@ This is primarily
intended for building libraries, where optimal ordering is not critical, intended for building libraries, where optimal ordering is not critical,
and cycles occur often. and cycles occur often.
.El .El
.Sh EXAMPLES
Assuming a file named
.Pa dag
with the following contents representing a directed acyclic graph:
.Bd -literal -offset indent
A B
A F
B C
B D
D E
.Ed
.Pp
Sort the nodes of the graph:
.Bd -literal -offset indent
$ tsort dag
A
F
B
D
C
E
.Ed
.Pp
White spaces and new line characters are considered equal.
This file for example is considered equal to the one we defined before:
.Bd -literal -offset indent
$ cat dga
A B A F B C B D D E
.Ed
.Pp
Assume we add a new directed arc from D to A creating a cycle:
.Bd -literal -offset indent
A B
A F
B C
B D
D E
D A
.Ed
.Pp
Ordering the graph detects the cycle:
.Bd -literal -offset indent
$ tsort dag
tsort: cycle in data
tsort: A
tsort: B
tsort: D
D
E
A
F
B
C
.Ed
.Pp
Same as above but silencing the warning about the cycle:
.Bd -literal -offset indent
$ tsort -q dag
D
E
A
F
B
C
.Ed
.Sh SEE ALSO .Sh SEE ALSO
.Xr ar 1 .Xr ar 1
.Sh HISTORY .Sh HISTORY