command-definition.cat.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of unix4j-command Show documentation
There is a newer version: 0.6
<?xml version="1.0"?>
<command-def	xmlns="http://www.unix4j.org/command-def" 
				xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
				xsi:schemaLocation="http://www.unix4j.org/command-def command-def.xsd">
	
	<command name="cat" class="org.unix4j.unix.Cat" package="org.unix4j.unix.cat"/>
	<name>
		cat - concatenate and print files
	</name>
	<synopsis>
		ORIGINAL:	cat [-u][file ...]
					cat [-benstuv] [file ...]
		CURRENT:	cat [-bns] [file ...]
	</synopsis>
	<description ref="cat.html"/>
	<notes/>
	<methods>
		<method args="" usesStandardInput="true">
			Reads the lines from the standard input and writes them to the
			standard output.
		</method>
		<method args="args" usesStandardInput="false">
			Reads the lines from files specified as arguments and writes them to
			the standard output. Options can be specified by acronym (with a
			leading dash "-") or by long name (with two leading dashes "--"). 
			File arguments are expanded if wildcards are used. All file 
			arguments are processed in command-argument order.
		</method>
		<method args="files" usesStandardInput="false">
			Reads the lines from the specified files and writes them to the
			standard output. The files are processed in command-argument order.
		</method>
		<method args="options" usesStandardInput="true">
			Reads the lines from the standard input and writes them to the
			standard output; the given options define the details of the output
			format.
		</method>
		<method args="options,files" usesStandardInput="false">
			Reads the lines from the specified files and writes them to the
			standard output; the given options define the details of the output
			format. The files are processed in command-argument order.
		</method>
		<method args="options,paths" usesStandardInput="false">
			Reads the lines from the specified files and writes them to the
			standard output; the given options define the details of the output
			format. The path arguments are expanded if wildcards are used and
			processed in command-argument order.
		</method>
	</methods>
	<options>
		<option name="numberNonBlankLines" acronym="b" exclusiveGroup="bn">
			Number the non-blank output lines, starting at 1.
		</option>
		<option name="numberLines" acronym="n" exclusiveGroup="bn">
			Number the output lines, starting at 1.
		</option>
		<option name="squeezeEmptyLines" acronym="s">
			Squeeze multiple adjacent empty lines, causing the output to be 
			single spaced.
		</option>
	</options>
	<operands default="paths">
		<operand name="files" type="java.io.File...">
			The input files to be printed; relative paths are not resolved (use 
			the string path argument to enable relative path resolving based on 
			the current working directory).
		</operand>
		<operand name="paths" type="String...">
			Pathnames of the input files to be printed; wildcards * and ? are
			supported; relative paths are resolved on the basis of the current 
			working directory.
		</operand>
		<operand name="args" type="String...">
			String arguments defining the options and file operands for the 
			command. Options can be specified by acronym (with a leading dash 
			"-") or by long name (with two leading dashes "--"). File arguments 
			are expanded if wildcards are used. 
		</operand>
		<operand name="options" type="CatOptions">
			Options for the cat command.
		</operand>
	</operands>
</command-def>