CHANGELOG.md

# unreleased

## Changes


## Features
- Allow hex numbers and units for `--block-size` argument, see #111

## Bugfixes


## Other


## Packaging


# v0.9.0

## Changes

- Breaking change (binary): setting the `-o/--display-offset` flag no longer overrides the value set by `--skip` [#115](https://github.com/sharkdp/hexyl/issues/115). The first displayed address is now the sum of the two values - this matches the behaviour of `xxd`.

## Features

- Allow relative and negative byte offsets (e.g. `hexyl --skip=-1block`), see #99 (@ErichDonGubler)
- Added `-l` as another alias for '-n/--length' (`xxd` compatibility), see #121 and #135 (@TheDoctor314)

## Bugfixes

- Argument `--length` silently takes precedence over `--bytes`, see #105
- Print warning on empty content, see #107 and #108
- Disallow block sizes of zero, see #110
- Fix newline appearing in `--version` output, see #131 and #133 (@scimas)

## Other

- Better diagnostic messages, see #98 (@ErichDonGubler)

## Packaging

- `hexyl` is now available on snapstore, see #116 (@purveshpatel511)

# v0.8.0

## Features

- A new `--skip <N>` / `-s <N>` option can be used to skip the first `N` bytes of the input, see #16, #88 (@Tarnadas, @MaxJohansen, @ErichDonGubler)
- The `--length`/`--bytes`/`--skip`/`--display-offset` options can now take units for their value argument, for example:
  ``` bash
  hexyl /dev/random --length=1KiB
  hexyl $(which hexyl) --skip=1MiB --length=10KiB
  ```
  Both decimal SI prefixes (kB, MB, …) as well as binary IEC prefixes (KiB, MiB, …) are supported.
  In addition, there is a new `--block-size <SIZE>` option that can be used to control the size of the `block`
  unit:
  ``` bash
  hexyl /dev/random --block-size=4kB --length=2block
  ```
  See: #44 (@ErichDonGubler and @aswild)

## Other

- Various improvements throughout the code base by @ErichDonGubler

## Packaging

- `hexyl` is now available on Void Linux, see #91 (@notramo)

# v0.7.0

## Bugfixes

- hexyl can now be closed with `Ctrl-C` when reading input from STDIN, see #84

## Changes

- Breaking change (library): [`Printer::print_all`](https://docs.rs/hexyl/latest/hexyl/struct.Printer.html#method.print_all) does not take a second argument anymore.
- Added an example on how to use `hexyl` as a library: https://github.com/sharkdp/hexyl/blob/v0.7.0/examples/simple.rs

# v0.6.0

## Features

- `hexyl` can now be used as a library, see #67 (@tommilligan)

- Added a new `-o`/`--display-offset` option to add a certain offset to the
  reported file positions, see #57 (@tommilligan)

## Bugfixes

- Remove additional space on short input, see #69 (@nalshihabi)

## Other

- Performance improvements, see #73 and #66

# v0.5.1

## Bugfixes

- A bug in the squeezing logic caused a wrong hexdump, see #62 (@awidegreen)
- Some colors are printed even if they're disabled, see #64 (@awidegreen)
- Fixed build failure on OpenBSD 6.5, see #61

# v0.5.0

## Features

- Added support for squeezing where reoccurring lines are squashed together and visualized with an asterisk. A new `-v`/`--no-squeezing` option can be used to disable the feature. For details, see #59 (@awidegreen)
- Added a new `--border` option with support for various styles (Unicode, ASCII, None), see #54 (@dmke)
- The `--length`/`-n` argument can be passed as a hexadecimal number (`hexyl -n 0xff /dev/urandom`), see #45 (@Qyriad)
- Added `--bytes`/`-c` as an alias for `--length`/`-n`, see #48 (@selfup)

## Changes

- Print header immediately before the first line, see #51 (@mziter)


# v0.4.0

## Features

- Added a new `--color=always/auto/never` option which can be used
  to control `hexyl`s color output, see #30 (@bennetthardwick)
- Use 16 colors instead of 256, see #38

## Changes

- Various speed improvements, see #33 (@kballard)

## Bugfixes

- Proper Ctrl-C handling, see #35
- Proper handling of broken pipes (`hexyl … | head`)

# v0.3.1

- Various (huge) performance improvements, see #23 and #24 (@kballard)
- Replaced 24-bit truecolor ANSI codes by 8-bit codes to support
  more terminal emulators, fixes #9

# v0.3.0

Windows support

# v0.2.0

Initial release
Update CHANGELOG 2020-10-30 19:00:36 +01:00			`# unreleased`

bin: offset should add to skip, not override it 2020-10-30 22:26:18 +00:00			`## Changes`

Bump version to 0.9.0 2021-07-11 19:59:56 +02:00
			`## Features`
Mention new feature in CHANGELOG 2021-11-07 22:40:55 +01:00			- Allow hex numbers and units for `--block-size` argument, see #111
Bump version to 0.9.0 2021-07-11 19:59:56 +02:00
			`## Bugfixes`


			`## Other`


			`## Packaging`




			`# v0.9.0`

			`## Changes`

bin: offset should add to skip, not override it 2020-10-30 22:26:18 +00:00			- Breaking change (binary): setting the `-o/--display-offset` flag no longer overrides the value set by `--skip` [#115](https://github.com/sharkdp/hexyl/issues/115). The first displayed address is now the sum of the two values - this matches the behaviour of `xxd`.

Update CHANGELOG 2020-10-30 19:00:36 +01:00			`## Features`

Update CHANGELOG 2020-10-30 20:02:16 +01:00			- Allow relative and negative byte offsets (e.g. `hexyl --skip=-1block`), see #99 (@ErichDonGubler)
Add CHANGELOG entry 2021-07-11 19:50:46 +02:00			- Added `-l` as another alias for '-n/--length' (`xxd` compatibility), see #121 and #135 (@TheDoctor314)
Update CHANGELOG 2020-10-30 20:02:16 +01:00
Update CHANGELOG 2020-10-30 19:00:36 +01:00			`## Bugfixes`

			- Argument `--length` silently takes precedence over `--bytes`, see #105
Update CHANGELOG 2020-10-30 19:34:12 +01:00			`- Print warning on empty content, see #107 and #108`
Disallow block sizes of 0 2020-10-31 10:10:46 +01:00			`- Disallow block sizes of zero, see #110`
Update CHANGELOG.md 2021-04-22 23:24:27 -06:00			- Fix newline appearing in `--version` output, see #131 and #133 (@scimas)
Update CHANGELOG 2020-10-30 19:00:36 +01:00
			`## Other`

Update CHANGELOG 2020-10-30 20:02:16 +01:00			`- Better diagnostic messages, see #98 (@ErichDonGubler)`

Update CHANGELOG 2020-10-30 19:00:36 +01:00			`## Packaging`

Move CHANGELOG entry 2020-10-30 19:57:07 +01:00			- `hexyl` is now available on snapstore, see #116 (@purveshpatel511)
Update CHANGELOG 2020-10-30 19:00:36 +01:00
Add CHANGELOG 2020-06-07 11:31:04 +02:00			`# v0.8.0`

			`## Features`

Improve help text 2020-06-07 14:37:17 +02:00			- A new `--skip <N>` / `-s <N>` option can be used to skip the first `N` bytes of the input, see #16, #88 (@Tarnadas, @MaxJohansen, @ErichDonGubler)
			- The `--length`/`--bytes`/`--skip`/`--display-offset` options can now take units for their value argument, for example:
Add CHANGELOG 2020-06-07 11:31:04 +02:00			``` bash
			`hexyl /dev/random --length=1KiB`
			`hexyl $(which hexyl) --skip=1MiB --length=10KiB`
			```
			`Both decimal SI prefixes (kB, MB, …) as well as binary IEC prefixes (KiB, MiB, …) are supported.`
			In addition, there is a new `--block-size <SIZE>` option that can be used to control the size of the `block`
			`unit:`
			``` bash
			`hexyl /dev/random --block-size=4kB --length=2block`
			```
			`See: #44 (@ErichDonGubler and @aswild)`

			`## Other`

			`- Various improvements throughout the code base by @ErichDonGubler`

			`## Packaging`

			- `hexyl` is now available on Void Linux, see #91 (@notramo)

			`# v0.7.0`

			`## Bugfixes`

Trim trailing whitespace 2021-08-27 21:36:56 +00:00			- hexyl can now be closed with `Ctrl-C` when reading input from STDIN, see #84
Add CHANGELOG 2020-06-07 11:31:04 +02:00
			`## Changes`

			- Breaking change (library): [`Printer::print_all`](https://docs.rs/hexyl/latest/hexyl/struct.Printer.html#method.print_all) does not take a second argument anymore.
			- Added an example on how to use `hexyl` as a library: https://github.com/sharkdp/hexyl/blob/v0.7.0/examples/simple.rs

			`# v0.6.0`

			`## Features`

			- `hexyl` can now be used as a library, see #67 (@tommilligan)

			- Added a new `-o`/`--display-offset` option to add a certain offset to the
			`reported file positions, see #57 (@tommilligan)`

			`## Bugfixes`

			`- Remove additional space on short input, see #69 (@nalshihabi)`

			`## Other`

			`- Performance improvements, see #73 and #66`

			`# v0.5.1`

			`## Bugfixes`

			`- A bug in the squeezing logic caused a wrong hexdump, see #62 (@awidegreen)`
			`- Some colors are printed even if they're disabled, see #64 (@awidegreen)`
			`- Fixed build failure on OpenBSD 6.5, see #61`

			`# v0.5.0`

			`## Features`

Fix typos 2021-08-27 21:36:36 +00:00			- Added support for squeezing where reoccurring lines are squashed together and visualized with an asterisk. A new `-v`/`--no-squeezing` option can be used to disable the feature. For details, see #59 (@awidegreen)
Add CHANGELOG 2020-06-07 11:31:04 +02:00			- Added a new `--border` option with support for various styles (Unicode, ASCII, None), see #54 (@dmke)
			- The `--length`/`-n` argument can be passed as a hexadecimal number (`hexyl -n 0xff /dev/urandom`), see #45 (@Qyriad)
			- Added `--bytes`/`-c` as an alias for `--length`/`-n`, see #48 (@selfup)

			`## Changes`

			`- Print header immediately before the first line, see #51 (@mziter)`


			`# v0.4.0`

			`## Features`

			- Added a new `--color=always/auto/never` option which can be used
			to control `hexyl`s color output, see #30 (@bennetthardwick)
			`- Use 16 colors instead of 256, see #38`

			`## Changes`

			`- Various speed improvements, see #33 (@kballard)`

			`## Bugfixes`

			`- Proper Ctrl-C handling, see #35`
			- Proper handling of broken pipes (`hexyl … \| head`)

			`# v0.3.1`

			`- Various (huge) performance improvements, see #23 and #24 (@kballard)`
			`- Replaced 24-bit truecolor ANSI codes by 8-bit codes to support`
			`more terminal emulators, fixes #9`

			`# v0.3.0`

			`Windows support`

			`# v0.2.0`

			`Initial release`