harakit/docs/fop.1

.\" 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 2024-06-17 "Harakit X.X.X"
.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 data read from the standard input.
.\"
.SH OPTIONS

.IP \fB-d\fP
Sets a delimiter by which the input data will be split into fields. The default
is an ASCII record separator.
.\"
.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 a need for the ability to modify select fields in this data
easily and quickly.

The idea for this utility originated in the fact that the GNU
.BR ls (1)
utility contains a
.B -h
option which enables human-readable units in file size outputs. This
functionality was broken out into
.BR hru (1),
but there was no easy way to modify the field in the ouput of
.BR ls (1p)
without creating a new tool.
.\"
.SH AUTHOR

Written by Emma Tebibyte
.MT emma@tebibyte.media
.ME .
.\"
.SH COPYRIGHT

Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/agpl.html>.
.\"
.SH SEE ALSO
.BR sed (1p)
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.\" 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/>.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
Makefile, docs: programmatically generate version for docs (i got tired of doing it myself) 2024-06-24 05:47:29 +00:00			`.TH FOP 1 2024-06-17 "Harakit X.X.X"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH NAME`
			`fop \(en field operator`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH SYNOPSIS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`fop`
			`.RB ( -d )`
			`.RB [ delimiter ]`
			`.RB index`
			`.RB program...`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH DESCRIPTION`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
fop.1: removes unnecessary stdin section and adds AUTHOR 2024-06-18 05:18:45 +00:00			`Performs operations on specified fields in data read from the standard input.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH OPTIONS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.IP \fB-d\fP`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`Sets a delimiter by which the input data will be split into fields. The default`
fop.1: removes Unicode representation of RS; hru.1: removes erroneous line break; mm.1: formatting & grammar; npc.1: dollar sign, not currency sign; rpn.1: syntax error; scrut.1: move description to DESCRIPTION; str.1: comma; swab.1: wording & escape codes; true.1: formatting 2024-06-06 05:07:15 +00:00			`is an ASCII record separator.`
			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH CAVEATS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`Field indices are zero-indexed, which may be unexpected behavior for some users.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH RATIONALE`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`With the assumption that tools will output data separated with ASCII field`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`separators, there is a need for the ability to modify select fields in this data`
			`easily and quickly.`
fop.1: initial commit 2024-03-29 22:47:00 +00:00
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`The idea for this utility originated in the fact that the GNU`
			`.BR ls (1)`
			`utility contains a`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.B -h`
			`option which enables human-readable units in file size outputs. This`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`functionality was broken out into`
			`.BR hru (1),`
			`but there was no easy way to modify the field in the ouput of`
			`.BR ls (1p)`
			`without creating a new tool.`
			`.\"`
fop.1: removes unnecessary stdin section and adds AUTHOR 2024-06-18 05:18:45 +00:00			`.SH AUTHOR`

			`Written by Emma Tebibyte`
			`.MT emma@tebibyte.media`
			`.ME .`
			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH COPYRIGHT`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`<https://gnu.org/licenses/agpl.html>.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
fop.1: initial commit 2024-03-29 22:47:00 +00:00			`.SH SEE ALSO`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.BR sed (1p)`