1 '\" te
   2 .\"  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH CACHEFSLOG 1M "Feb 7, 1997"
   7 .SH NAME
   8 cachefslog \- Cache File System logging
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcachefslog\fR [\fB-f\fR \fIlogfile\fR | \fB-h\fR] \fIcachefs_mount_point\fR
  13 .fi
  14 
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBcachefslog\fR command displays where CacheFS statistics are being
  19 logged. Optionally, it sets where CacheFS statistics are being logged, or it
  20 halts logging for a cache specified by \fIcachefs_mount_point\fR. The
  21 \fIcachefs_mount_point\fR argument is a mount point of a cache file system.
  22 All file systems cached under the same cache as \fIcachefs_mount_point\fR will
  23 be logged.
  24 .SH OPTIONS
  25 .sp
  26 .LP
  27 The following options are supported. You must be super-user to use the \fB-f\fR
  28 and \fB-h\fR options.
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fB-f\fR \fIlogfile\fR\fR
  33 .ad
  34 .RS 14n
  35 Specify the log file to be used.
  36 .RE
  37 
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fB-h\fR\fR
  42 .ad
  43 .RS 14n
  44 Halt logging.
  45 .RE
  46 
  47 .SH OPERANDS
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIcachefs_mount_point\fR\fR
  52 .ad
  53 .RS 23n
  54 A mount point of a cache file system.
  55 .RE
  56 
  57 .SH USAGE
  58 .sp
  59 .LP
  60 See \fBlargefile\fR(5) for the description of the behavior of \fBcachefslog\fR
  61 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
  62 .SH EXAMPLES
  63 .LP
  64 \fBExample 1 \fRChecking the Logging of a directory.
  65 .sp
  66 .LP
  67 The example below checks if the directory \fB/home/sam\fR is being logged:
  68 
  69 .sp
  70 .in +2
  71 .nf
  72 example% cachefslog /home/sam
  73 not logged: /home/sam\fI\fR
  74 .fi
  75 .in -2
  76 .sp
  77 
  78 .LP
  79 \fBExample 2 \fRChanging the \fIlogfile\fR.
  80 .sp
  81 .LP
  82 The example below changes the \fIlogfile\fR of  \fB/home/sam\fR to
  83 \fB/var/tmp/samlog\fR:
  84 
  85 .sp
  86 .in +2
  87 .nf
  88 example# cachefslog -f /var/tmp/samlog /home/sam
  89 /var/tmp/samlog: /home/sam \fI\fR
  90 .fi
  91 .in -2
  92 .sp
  93 
  94 .LP
  95 \fBExample 3 \fRVerifying the change of a \fIlogfile\fR.
  96 .sp
  97 .LP
  98 The example below verifies the change of the previous example:
  99 
 100 .sp
 101 .in +2
 102 .nf
 103 example% cachefslog /home/sam
 104 /var/tmp/samlog: /home/sam \fI\fR
 105 .fi
 106 .in -2
 107 .sp
 108 
 109 .LP
 110 \fBExample 4 \fRHalting the logging of a directory.
 111 .sp
 112 .LP
 113 The example below halts logging for the \fB/home/sam\fR directory:
 114 
 115 .sp
 116 .in +2
 117 .nf
 118 example# cachefslog -h /home/sam
 119 not logged: /home/sam\fI\fR
 120 .fi
 121 .in -2
 122 .sp
 123 
 124 .SH EXIT STATUS
 125 .sp
 126 .LP
 127 The following exit values are returned:
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fB0\fR\fR
 132 .ad
 133 .RS 12n
 134 success
 135 .RE
 136 
 137 .sp
 138 .ne 2
 139 .na
 140 \fBnon-zero\fR
 141 .ad
 142 .RS 12n
 143 an error has occurred.
 144 .RE
 145 
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBcachefsstat\fR(1M), \fBcachefswssize\fR(1M), \fBcfsadmin\fR(1M),
 150 \fBattributes\fR(5), \fBlargefile\fR(5)
 151 .SH DIAGNOSTICS
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBInvalid path\fR\fR
 156 .ad
 157 .RS 16n
 158 It is illegal to specify a path within a cache file system.
 159 .RE
 160