walk.1

.\" Copyright 2019 Google LLC
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
.\" You may obtain a copy of the License at
.\"
.\"     https://www.apache.org/licenses/LICENSE-2.0
.\"
.\" Unless required by applicable law or agreed to in writing, software
.\" distributed under the License is distributed on an "AS IS" BASIS,
.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.TH WALK 1 2019-09-16
.SH NAME
walk \- walk file system
.SH SYNOPSIS
.B walk
.RB [\| \-0 \]
.RI [\| DIRECTORY ...\]
.SH DESCRIPTION
Recursively list the specified
.I DIRECTORY
(or directories). Recursively list the current directory if no directory is
specified.
.SH OPTIONS
.TP
\fB\-0\fP, \fB\-\-null\fP
Terminate output filenames using the null character \fB\\0\fP instead of newlines.
Suitable for use with \fBsor \-0\fP.
.TP
\fB\-\-help\fP
Print a summary of the usage of \fBwalk\fP and exit.
.SH "EXIT STATUS"
.BR walk 's
exit status is a bitmask indicating errors that occurred.
.TP
0x0
No errors occurred.
.TP
0x1
General error (usually because
.B walk
could not traverse a directory due to insufficient permissions).
.TP
0x2
One of the arguments was not a directory.
.SH NOTES
.B walk
does not traverse symlinks.
.SH "SEE ALSO"
.BR find (1),
.BR sor (1)