fop.1: initial commit

This commit is contained in:
Emma Tebibyte 2024-03-29 16:47:00 -06:00
parent 5db09a5ca1
commit 13ee16173e
Signed by: emma
GPG Key ID: 06FA419A1698C270

60
docs/fop.1 Normal file
View File

@ -0,0 +1,60 @@
.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
.\"
.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
.TH fop 1
.SH NAME
fop \(en field operator
.SH SYNOPSIS
fop
.RB ( -d )
.RB [ delimiter ]
.RB index
.RB program...
.SH DESCRIPTION
Performs operations on specified fields in input data.
.SH OPTIONS
.B -d
.RS
Sets a delimiter by which the input data will be split into fields. The default
is an ASCII record separator (␞).
.RE
.SH STANDARD INPUT
Data will be read from the standard input.
.SH CAVEATS
Field indices are zero-indexed, which may be unexpected behavior for some users.
.SH RATIONALE
With the assumption that tools will output data separated with ASCII field
separators, there is
The idea for this utility originated in the fact that GNU ls(1) utility contains
a
.B -h
option which enables human-readable units in file size outputs. This
functionality was broken out into hru(1), but there was no easy way to modify
the field in the ouput of ls(1p) without a new tool.
.SH COPYRIGHT
Copyright © 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/agpl.html>.
.SH SEE ALSO
sed(1p)