usr.bin/tsort/tsort.1

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