Differential D16132 Diff 50015 usr.bin/cmb/cmb.1

Changeset View

Standalone View

usr.bin/cmb/cmb.1

This file was added.

Property	Old Value	New Value
svn:eol-style	null	native \ No newline at end of property
svn:keywords	null	FreeBSD=%H \ No newline at end of property
svn:mime-type	null	text/plain \ No newline at end of property

.\"

pauamma_gundo.comUnsubmitted

Not Done

SPDX license ID for new files.

pauamma_gundo.com: SPDX license ID for new files.

.\" Redistribution and use in source and binary forms, with or without

.\" modification, are permitted provided that the following conditions

.\" are met:

.\" 1. Redistributions of source code must retain the above copyright

.\" notice, this list of conditions and the following disclaimer.

.\" 2. Redistributions in binary form must reproduce the above copyright

.\" notice, this list of conditions and the following disclaimer in the

.\" documentation and/or other materials provided with the distribution.

.\"

.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND

.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.\" $FrauBSD: pkgcenter/depend/cmb/cmb.1 2018-11-04 01:38:00 -0700 freebsdfrau $

.\" $FreeBSD$

.\"

pauamma_gundo.comUnsubmitted

Not Done

No longer needed.

pauamma_gundo.com: No longer needed.

.Dd November 4, 2018

.Dt CMB 1

pauamma_gundo.comUnsubmitted

Not Done

Bump.

pauamma_gundo.com: Bump.

.Os

.Sh NAME

.Nm cmb

.Nd combinatorics utility

.Sh SYNOPSIS

.Nm

.Op Fl 0et

.Op Fl c Ar #

.Op Fl d Ar str

.Op Fl i Ar #

.Op Fl k Ar size

.Op Fl p Ar str

.Op Fl s Ar str

.Ar item1

.Ar ...

.Sh DESCRIPTION

The

.Nm

utility prints combinations,

one per line

.Pq default ,

with items in each combination separated by space

.Pq default .

Given N items on the command-line,

there are N sets where each set consists of an increasing number of items.

By default,

all sets are produced

.Pq Ql Li -k 0 .

Combination order within a set of N-items is always consistent and repeatable

given the order of items on the command-line.

The order of combinations within a single set of N-items

.Pq where every combination in the set has the same number of items

is dependent upon the order of items on the command-line.

.Pp

pauamma_gundo.comUnsubmitted

Not Done

.Pq Ql Li -k 0 .

- Combination order within a set of N-items is always consistent and repeatable

+ Combination order within a set of N items is always consistent and repeatable

given the order of items on the command-line.

pauamma_gundo.com:

Available options:

pauamma_gundo.comUnsubmitted

Not Done

Combination order within a set of N-items is always consistent and repeatable

- given the order of items on the command-line.

+ given the order of items on the command line.

The order of combinations within a single set of N-items

pauamma_gundo.com:

.Bl -tag -width ".Fl r Ar size"

pauamma_gundo.comUnsubmitted

Not Done

given the order of items on the command-line.

- The order of combinations within a single set of N-items

+ The order of combinations within a single set of N items

.Pq where every combination in the set has the same number of items

pauamma_gundo.com:

.It Fl 0

Terminate combinations with ASCII NUL

pauamma_gundo.comUnsubmitted

Not Done

.Pq where every combination in the set has the same number of items

- is dependent upon the order of items on the command-line.

+ is dependent upon the order of items on the command line.

.Pp

Available options:

pauamma_gundo.com:

.Pq character code 0

instead of newline.

Use in conjunction with

.Dq Li xargs -0

for example.

.It Fl c Ar num

Produce

pauamma_gundo.comUnsubmitted

Not Done

.Ql Fl f

- to read items separated by NUL character

+ to read items separated by a NUL character

.Pq character code 0

pauamma_gundo.com:

.Ar num

combinations.

.Ql 0

pauamma_gundo.comUnsubmitted

Not Done

.It Fl c Ar num

- Produce at-most

+ Produce at most

.Ar num

pauamma_gundo.com:

.Pq default

all combinations produced.

.It Fl d Ar text

Delimiter for separating items.

Default is space

.Pq Dq " " .

.It Fl e

Show empty set.

A single combination containing no-items.

.It Fl i Ar num

Skip the first

.Va num-1

combinations.

.Va num

is negative,

skip to

.Va |num|

combinations before the end.

.Va num

pauamma_gundo.comUnsubmitted

Not Done

Show empty set.

- A single combination containing no-items.

+ A single combination containing no items.

.It Fl F Ar num

pauamma_gundo.com:

matches

.Ql Li random

.Pq case-sensitive

a random number between 1 and the total number of combinations is chosen.

.It Fl k Ar size

Number or range

.Pq Qo min..max Qc or Qo min-max Qc

of how many items must appear in each combination.

A value of

.Ql 0

.Pq default

calculates all sets starting with 1-item combinations.

.Va size

pauamma_gundo.comUnsubmitted

Not Done

.Ql Fl 0 ,

- read items separated by NUL character.

+ read items separated by a NUL character.

If an argument is

pauamma_gundo.com:

is negative one

.Pq Li -1 ,

calculate sets in descending order,

starting with the maximum number of items.

pauamma_gundo.comUnsubmitted

Not Done

Maybe add that the limit is 2^32-1 for people who don't have powers of 2 memorized and to explain why it's that.

pauamma_gundo.com: Maybe add that the limit is 2^32-1 for people who don't have powers of 2 memorized and to…

A range of

.Ql Li -1..N

will do the same but stop at N-item combinations.

A range of

.Ql Li N..-1

will start with N-item combinations and end with the maximum number of items.

The order of combinations in each set is unaffected by negative

.Va size

values.

A range of

.Ql Li -1..-1

calculates the ending set consisting of only the maximum number of items.

.It Fl n Ar num

Limit the number of arguments taken from the command-line.

No effect if

.Va num

is greater than the number of arguments.

.It Fl p Ar text

Prefix each combination with

.Ar text .

.It Fl s Ar text

Suffix each combination with

.Ar text .

.It Fl t

Print total number of combinations and exit.

.El

.Sh EXAMPLES

Print all two-word combinations

.Pq Qo bird dog Qc , Qo bird house Qc , and Qo dog house Qc

given

.Qq bird ,

.Qq dog ,

and

.Qq house :

.Bd -literal -offset indent

cmb -k 2 bird dog house

.Ed

.Pp

Print number of combinations

.Pq 7

given

.Qq a ,

.Qq b ,

and

.Qq c :

.Bd -literal -offset indent

cmb -t a b c

.Ed

.Pp

Print first 5 combinations

.Pq Qo x Qc , Qo y Qc , Qo z Qc , Qo x y Qc , and Qo x z Qc

given

.Qq x ,

.Qq y ,

and

.Qq z :

.Bd -literal -offset indent

cmb -c 5 x y z

.Ed

.Pp

Skip first 3 combinations

.Pq Qo x Qc , Qo y Qc , and Qo z Qc

given

.Qq x ,

.Qq y ,

and

.Qq z :

.Bd -literal -offset indent

cmb -i 4 x y z

.Ed

.Pp

Print last 5 combinations

.Pq Qo z Qc , Qo x y Qc , Qo x z Qc , Qo y z Qc , and Qo x y z Qc

given

.Qq x ,

.Qq y ,

and

.Qq z :

.Bd -literal -offset indent

cmb -i -5 x y z

.Ed

.Pp

Print items separated by comma instead of space:

.Bd -literal -offset indent

cmb -d , a b c

.Ed

.Pp

Print numbers as JSON:

.Bd -literal -offset indent

cmb -p '{"values":[' -s ']}' -d , 1 2 3

.Ed

.Pp

Print strings as JSON:

.Bd -literal -offset indent

cmb -p '{"values":[' -s ']}' -d , '"a"' '"b"' '"c"'

.Ed

.Pp

Print all 2- and 3-word combinations

.Po

.Qq big blue ,

.Qq big red ,

pauamma_gundo.comUnsubmitted

Not Done

expand to numbers min to max.

- Numbers must be whole positive integers between 0 and 4294967295.

+ Numbers must be integers between 0 and 4294967295

+ .Pq 2^32-1 .

.It Fl S

pauamma_gundo.com:

.Qq big couch ,

.Qq blue red ,

.Qq blue couch ,

.Qq red couch ,

.Qq big blue red ,

.Qq big blue couch ,

.Qq big red couch ,

and

.Qq blue red couch

.Pc

given

.Qq big ,

.Qq blue ,

.Qq red ,

and

.Qq couch :

.Bd -literal -offset indent

cmb -k 2..3 big blue red couch

.Ed

.Pp

Print combinations starting with the maximum number of items

.Pq 3 ,

ending with 2-item combinations:

.Bd -literal -offset indent

pauamma_gundo.comUnsubmitted

Not Done

library version and

- .Pq if-enabled

+ .Pq if enabled

.Xr SSL 3

pauamma_gundo.com:

cmb -k -1..2 1 2 3

.Ed

.Pp

Print combinations starting with 2-items ending with maximum items

.Pq 3 :

.Bd -literal -offset indent

cmb -k 2..-1 x y z

.Ed

.Pp

Roll a set of 2 six-sided dice,

producing a single random combination of two numbers:

.Bd -literal -offset indent

cmb -c 1 -k 2 -i rand 1 2 3 4 5 6 1 2 3 4 5 6

.Ed

.Sh HISTORY

The

.Nm

utility first appeared in

.Fx 13.0 .

.Sh AUTHORS

.An Devin Teske Aq Mt dteske@FreeBSD.org

pauamma_gundo.comUnsubmitted

Not Done

cmb -k -1..2 1 2 3

.Ed

.Pp

- Print combinations starting with 2-items ending with maximum items

+ Print combinations starting with 2 items ending with maximum items

.Pq 3 :

pauamma_gundo.com:

pauamma_gundo.comUnsubmitted

Not Done

I guess it's 15.0 now.

pauamma_gundo.com: I guess it's 15.0 now.