sbase/cmp.1

.Dd 2015-10-08
.Dt CMP 1
.Os sbase
.Sh NAME
.Nm cmp
.Nd compare two files
.Sh SYNOPSIS
.Nm
.Op Fl l | Fl s
.Ar file1 file2
.Sh DESCRIPTION
.Nm
compares
.Ar file1
and
.Ar file2
byte by byte.
If they differ,
.Nm
writes the first differing byte- and line-number to stdout.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl l
Print byte-number and bytes (in octal) for each difference.
.It Fl s
Print nothing and only return status.
.El
.Sh EXIT STATUS
.Bl -tag -width Ds
.It 0
.Ar file1
and
.Ar file2
are identical.
.It 1
.Ar file1
and
.Ar file2
are different.
.It > 1
An error occurred.
.El
.Sh SEE ALSO
.Xr comm 1 ,
.Xr diff 1
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification.
.Pp
The "char" in the default result format has been replaced with "byte".
Use ISO-date-format in manpages The one specified by mdoc is hard to read for non-native speakers from countries which read the date day-first (like Germany, Greece, North-Korea, Swamp,...). This is also consistent with how we generally specify dates at suckless.org. 2015-10-08 15:15:08 +00:00			`.Dd 2015-10-08`
remove sbase-VERSION from man page, fix sponge.1 date 2015-01-31 13:20:02 +00:00			`.Dt CMP 1`
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install 2015-01-31 19:37:03 +00:00			`.Os sbase`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.Sh NAME`
			`.Nm cmp`
			`.Nd compare two files`
			`.Sh SYNOPSIS`
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff. 2015-01-30 20:17:58 +00:00			`.Nm`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.Op Fl l \| Fl s`
			`.Ar file1 file2`
			`.Sh DESCRIPTION`
			`.Nm`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`compares`
			`.Ar file1`
			`and`
			`.Ar file2`
Fix various lint warnings in manuals Fix "new sentence, new line" warnings throughout so that formatters can produce correct spacing between sentences. join.1 Remove unnecessary Ns macros. These are not necessary for delimeters, which get special treatment. xinstall.1 Fix date in manual. The contents were last modified on 2016-12-03, so use that instead of the invalid date. grep.1 Fix escape sequence for `\<` and `\>`. ed.1 Remove spurious `\\n` escape for the null-command. 2020-03-01 22:37:31 +00:00			`byte by byte.`
			`If they differ,`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.Nm`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`writes the first differing byte- and line-number to stdout.`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
			`.It Fl l`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`Print byte-number and bytes (in octal) for each difference.`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.It Fl s`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`Print nothing and only return status.`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.El`
			`.Sh EXIT STATUS`
			`.Bl -tag -width Ds`
			`.It 0`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`.Ar file1`
			`and`
			`.Ar file2`
			`are identical.`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.It 1`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`.Ar file1`
			`and`
			`.Ar file2`
			`are different.`
Minor update to cmp(1) manpage 2014-11-21 13:11:48 +00:00			`.It > 1`
man pages: fix some typos 2015-02-01 20:28:17 +00:00			`An error occurred.`
Update cmp(1) manpage to new style and do not allow both -l and -s to be set 2014-11-21 12:03:27 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr comm 1 ,`
			`.Xr diff 1`
cmp(1) is POSIX compliant so mention it in the manpage Update format specifiers for -l as specified by POSIX. 2014-11-21 12:31:23 +00:00			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility is compliant with the`
POSIX 2013 audit Mostly manpage-shuffling according to the changes in the corrigendum, wording changes and more idiomatic expressions. All this is finished up by marking the POSIX 2013 conformant tools with .St -p1003.1-2013 which is not available in older mandoc builds or nroff, but which reflects what we actually did, so who cares? This is a huge step and it's not far until we can release sbase 0.1. 2015-03-27 16:22:48 +00:00			`.St -p1003.1-2013`
cmp(1) is POSIX compliant so mention it in the manpage Update format specifiers for -l as specified by POSIX. 2014-11-21 12:31:23 +00:00			`specification.`
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README. 2015-02-07 20:05:33 +00:00			`.Pp`
			`The "char" in the default result format has been replaced with "byte".`