xref: /dragonfly/usr.bin/tsort/tsort.1 (revision cfd1aba3)
1.\" Copyright (c) 1990, 1993, 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This manual is derived from one contributed to Berkeley by
5.\" Michael Rendell of Memorial University of Newfoundland.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)tsort.1	8.3 (Berkeley) 4/1/94
32.\" $FreeBSD: src/usr.bin/tsort/tsort.1,v 1.7.2.3 2002/07/15 08:02:19 keramida Exp $
33.\" $DragonFly: src/usr.bin/tsort/tsort.1,v 1.2 2003/06/17 04:29:33 dillon Exp $
34.\"
35.Dd April 1, 1994
36.Dt TSORT 1
37.Os
38.Sh NAME
39.Nm tsort
40.Nd topological sort of a directed graph
41.Sh SYNOPSIS
42.Nm
43.Op Fl dlq
44.Op Ar file
45.Sh DESCRIPTION
46The
47.Nm
48utility takes a list of pairs of node names representing directed arcs in
49a graph and prints the nodes in topological order on standard output.
50Input is taken from the named
51.Ar file ,
52or from standard input if no file
53is given.
54.Pp
55Node names in the input are separated by white space and there must
56be an even number of nodes.
57.Pp
58Presence of a node in a graph can be represented by an arc from the node
59to itself.
60This is useful when a node is not connected to any other nodes.
61.Pp
62If the graph contains a cycle (and therefore cannot be properly sorted),
63one of the arcs in the cycle is ignored and the sort continues.
64Cycles are reported on standard error.
65.Pp
66The options are as follows:
67.Bl -tag -width Ds
68.It Fl d
69Turn on debugging.
70.It Fl l
71Search for and display the longest cycle.
72Can take a very long time.
73.It Fl q
74Do not display informational messages about cycles.  This is primarily
75intended for building libraries, where optimal ordering is not critical,
76and cycles occur often.
77.El
78.Sh SEE ALSO
79.Xr ar 1
80.Sh HISTORY
81A
82.Nm
83command appeared in
84.At v7 .
85This
86.Nm
87command and manual page are derived from sources contributed to Berkeley by
88Michael Rendell of Memorial University of Newfoundland.
89