xref: /freebsd/packages/dwatch/dwatch.ucl (revision bb75b0d581f74e22a68d7868ad1f5da1146a8de0)
1*bb75b0d5SLexi Winter/*
2*bb75b0d5SLexi Winter * SPDX-License-Identifier: BSD-2-Clause
3*bb75b0d5SLexi Winter *
4*bb75b0d5SLexi Winter * Copyright (c) 2014-2018 Devin Teske
5*bb75b0d5SLexi Winter * All rights reserved.
6*bb75b0d5SLexi Winter *
7*bb75b0d5SLexi Winter * Redistribution and use in source and binary forms, with or without
8*bb75b0d5SLexi Winter * modification, are permitted provided that the following conditions
9*bb75b0d5SLexi Winter * are met:
10*bb75b0d5SLexi Winter * 1. Redistributions of source code must retain the above copyright
11*bb75b0d5SLexi Winter *    notice, this list of conditions and the following disclaimer.
12*bb75b0d5SLexi Winter * 2. Redistributions in binary form must reproduce the above copyright
13*bb75b0d5SLexi Winter *    notice, this list of conditions and the following disclaimer in the
14*bb75b0d5SLexi Winter *    documentation and/or other materials provided with the distribution.
15*bb75b0d5SLexi Winter *
16*bb75b0d5SLexi Winter * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17*bb75b0d5SLexi Winter * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18*bb75b0d5SLexi Winter * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19*bb75b0d5SLexi Winter * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20*bb75b0d5SLexi Winter * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21*bb75b0d5SLexi Winter * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22*bb75b0d5SLexi Winter * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*bb75b0d5SLexi Winter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24*bb75b0d5SLexi Winter * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25*bb75b0d5SLexi Winter * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26*bb75b0d5SLexi Winter * POSSIBILITY OF SUCH DAMAGE.
27*bb75b0d5SLexi Winter */
28*bb75b0d5SLexi Winter
29*bb75b0d5SLexi Wintercomment = "Watch processes as they trigger a particular DTrace probe"
30*bb75b0d5SLexi Winter
31*bb75b0d5SLexi Winterdesc = <<EOD
32*bb75b0d5SLexi WinterThe dwatch(1) utility uses dtrace(1) to display process info when a given
33*bb75b0d5SLexi WinterDTrace probe point is triggered.  dwatch automates the process of generating
34*bb75b0d5SLexi WinterDTrace scripts to coalesce trace output by date/time, process info, and
35*bb75b0d5SLexi Winter[optionally] probe-specific data.  dwatch also includes a set of pre-defined
36*bb75b0d5SLexi Winterprofiles for tracing common system operations.
37*bb75b0d5SLexi WinterEOD
38