harakit/docs/hru.1

.\" 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 HRU 1 2024-06-17 "Bonsai Core Utilites 0.13.11"
.SH NAME
hru \(en human readable units
.\"
.SH SYNOPSIS

hru
.\"
.SH DESCRIPTION

Convert counts to higher units.

Byte counts will be read in the form of whole numbers from the standard input
and be written to the standard output the same number converted to a higher unit
of data as defined by the \fIInternational System of Units\fP.

The program will convert the byte count to the highest unit possible where the
value is greater than one.
.\"
.SH DIAGNOSTICS

If encountering non-integer characters in the standard input, the program will
exit with the appropriate error code as defined by
.BR sysexits.h (3)
and print an error message.
.\"
.SH RATIONALE

The GNU project\(cqs
.BR ls (1)
implementation contains a human-readable option (\fB-h\fP) that, when specified,
makes the tool print size information in a format more immediately
readable. This functionality is useful not only in this context, so the decision
was made to split it into a new tool. The original functionality from GNU\(cqs
.BR ls (1)
can be emulated with
.BR fop (1)
combined with this program.
.\"
.SH STANDARDS

The standard unit prefixes as specified by the
.I Bureau International des Poids et Mesures
.RI ( BIPM )
in the ninth edition of
.I The International System of Units
.RI ( SI )
are utilized for the ouput of conversions.
.\"
.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
GNU
.BR ls (1),
.I The International System of Units (SI) 9th Edition
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.\" 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			`.\"`
fop(1): record separator worky now? 2024-06-21 09:23:39 +00:00			`.TH HRU 1 2024-06-17 "Bonsai Core Utilites 0.13.11"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH NAME`
			`hru \(en human readable units`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH SYNOPSIS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`hru`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH DESCRIPTION`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: remove unnecessary references to the name of each program 2024-03-27 01:22:30 +00:00			`Convert counts to higher units.`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
hru.1: italics and removes clunky sentences 2024-06-18 05:09:15 +00:00			`Byte counts will be read in the form of whole numbers from the standard input`
			`and be written to the standard output the same number converted to a higher unit`
			`of data as defined by the \fIInternational System of Units\fP.`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
hru.1: update manpage to be more clear 2024-02-18 21:59:12 +00:00			`The program will convert the byte count to the highest unit possible where the`
			`value is greater than one.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH DIAGNOSTICS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
docs: remove unnecessary references to the name of each program 2024-03-27 01:22:30 +00:00			`If encountering non-integer characters in the standard input, the program will`
hru.1: fixes formatting 2024-06-04 05:52:28 +00:00			`exit with the appropriate error code as defined by`
			`.BR sysexits.h (3)`
			`and print an error message.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH RATIONALE`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
hru.1: fixes formatting 2024-06-04 05:52:28 +00:00			`The GNU project\(cqs`
			`.BR ls (1)`
			`implementation contains a human-readable option (\fB-h\fP) that, when specified,`
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			`makes the tool print size information in a format more immediately`
hru.1: italics and removes clunky sentences 2024-06-18 05:09:15 +00:00			`readable. This functionality is useful not only in this context, so the decision`
			`was made to split it into a new tool. The original functionality from GNU\(cqs`
hru.1: fixes formatting 2024-06-04 05:52:28 +00:00			`.BR ls (1)`
			`can be emulated with`
			`.BR fop (1)`
			`combined with this program.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH STANDARDS`
docs: removed unnecessary comments 2024-06-04 05:07:19 +00:00
hru.1: italics and removes clunky sentences 2024-06-18 05:09:15 +00:00			`The standard unit prefixes as specified by the`
			`.I Bureau International des Poids et Mesures`
			`.RI ( BIPM )`
			`in the ninth edition of`
			`.I The International System of Units`
			`.RI ( SI )`
hru.1: fixes formatting 2024-06-04 05:52:28 +00:00			`are utilized for the ouput of conversions.`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH AUTHOR`
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			`Written by Emma Tebibyte`
			`.MT emma@tebibyte.media`
			`.ME .`
			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +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`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +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			`.\"`
hru.1: added manpage for hru(1) 2024-02-15 06:31:54 +00:00			`.SH SEE ALSO`
docs: updates to use man(7) macros to fix formatting 2024-06-03 00:47:14 +00:00			`GNU`
			`.BR ls (1),`
hru.1: italics and removes clunky sentences 2024-06-18 05:09:15 +00:00			`.I The International System of Units (SI) 9th Edition`