usr.sbin/crash/crash.8

   1 .\"     $NetBSD: crash.8,v 1.1 2009/03/07 22:08:08 ad Exp $
   2 .\"
   3 .\" Copyright (c) 2009 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Andrew Doran.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd March 7, 2009
  31 .Dt CRASH 8
  32 .Os
  33 .Sh NAME
  34 .Nm crash
  35 .Nd examine and debug system images
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl M Ar core
  39 .Op Fl N Ar system
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 command is used to examine and debug system images.
  44 .Pp
  45 If run without any arguments,
  46 .Nm
  47 operates on the running system.
  48 .Pp
  49 The options are as follows:
  50 .Bl -tag -width xpalidocious
  51 .It Fl M Ar core
  52 Operate on the specified crash dump instead of the default
  53 .Pa /dev/mem .
  54 Crash dumps should be from the same version of the system and same machine
  55 architecture as the running version of
  56 .Nm crash ,
  57 and must be uncompressed.
  58 .It Fl N Ar kernel
  59 Extract the name list from the specified kernel instead of the default
  60 .Pa /dev/ksyms .
  61 .El
  62 .Pp
  63 The command syntax used by
  64 .Nm
  65 is the same as the in-kernel debugger.
  66 See the
  67 .Xr ddb 4
  68 manual page for more information.
  69 .Pp
  70 Operations and facilities that require a running system, such as breakpoints,
  71 are not supported by
  72 .Nm crash .
  73 .Pp
  74 .Nm
  75 does not provide pagination.
  76 However, by using the pipe symbol, output may be sent to commands available
  77 from the shell.
  78 For example:
  79 .Bd -literal -offset abcd
  80 crash\*[Gt] ps | more
  81 crash\*[Gt] ps | grep ioflush
  82 .Ed
  83 .Sh SEE ALSO
  84 .Xr ps 1 ,
  85 .Xr vmstat 1 ,
  86 .Xr ddb 4 ,
  87 .Xr pstat 8
  88 .Sh HISTORY
  89 The
  90 .Nm
  91 command appeared in
  92 .Nx 6.0 .