.\"  $HeadURL$ $LastChangedRevision$
.\"
.TH LSPIPE 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.ne 5
.SH NAME
lspipe \- list files specified on stdin
.br
.ne 5
.SH SYNOPSIS
.B lspipe
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
[
.B \-m 
|
.B \-u
|
.B \-c
|
.B \-n
] [
.B \-r
]
.br
.ne 5
.SH DESCRIPTION
.B Lspipe
reads filenames from standard input, orders them
according to the specified options, and lists them
in the same format as
.B ls\fR(1)
would with its 
.B \-l
option.
.PP
Because 
.B lspipe
does not break the shell's maximum line length, there are 
situations in which it is better than:
.IP
.nf
.fam C
ls -d \fIls_options\fR `find \fIfind_options\fR`
.fam T
.fi
.PP
Because 
.B lspipe
does not need to divide the file list into chunks of a size
that does not break the shell's maximum line length, there
are situations in which it is better than:
.IP
.nf
.fam C
find \fIfind_options\fR | xargs ls -d \fIls_options\fR
.fam T
.fi
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-c
Sort by inode modification time; commonly but wrongly known as creation time.
.TP
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B lspipe
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-m
Sort by file modification time.
.TP
.B \-n
Sort by file name.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B lspipe
uses.
.TP
.B \-r
Reverse the order of sorting.
.TP
.B \-u
Leave file list unsorted.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.br
.ne 5
.SH EXIT STATUS
On success
.B lspipe
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
The following command sorts all files in your home directory by modification time:
.IP
.nf
.fam C
.B find $HOME -type f | lspipe -m
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B lspipe\fR.
.br
.ne 5
.SH SEE ALSO
ls(1), xargs(1), find(1)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 1995-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.