File: usage — Documentation by YARD 0.9.44

# Usage

## CLI

### General help

List commands:

    $ unisec --help

    Commands:
      unisec bidi [SUBCOMMAND]
      unisec blocks [SUBCOMMAND]
      unisec confusables [SUBCOMMAND]
      unisec dump [SUBCOMMAND]
      unisec grep REGEXP                              # Search for Unicode code point names by regular expression
      unisec normalize [SUBCOMMAND]
      unisec planes [SUBCOMMAND]
      unisec properties [SUBCOMMAND]
      unisec size INPUT                               # All kinf of size information about a Unicode string
      unisec surrogates [SUBCOMMAND]
      unisec versions                                 # Version of anything related to Unicode as used in unisec

List sub-commands:

    $ unisec surrogates --help
    Commands:
      unisec surrogates from HIGH LOW                 # Code point ⬅️ Surrogates
      unisec surrogates to NAME                       # Code point ➡️ Surrogates

Sub-command help:

    $ unisec surrogates from --help
    Command:
      unisec surrogates from

    Usage:
      unisec surrogates from HIGH LOW

    Description:
      Code point ⬅️ Surrogates

    Arguments:
      HIGH                              # REQUIRED High surrogate (in hexadecimal (0xXXXX), decimal (0dXXXX), binary (0bXXXX) or as text)
      LOW                               # REQUIRED Low surrogate (in hexadecimal (0xXXXX), decimal (0dXXXX), binary (0bXXXX) or as text)

    Options:
      --help, -h                        # Print this help

### Examples

- BiDi
  - Spoof
- Blocks
  - List
  - Reverse
  - Search
- Confusables
  - List
  - Randomize
- Grep
- Dump
  - Codepoints
    - Integer
    - Standard
  - Dec
  - Hex
- Normalize
  - All
  - Replace
  - Reverse
- Planes
  - Block
  - List
  - Reverse
  - Search
- Properties
  - Char
  - Codepoints
  - List
- Size
- Surrogates
  - From
  - To
- Versions

Library documentation for commands.

## Library

See examples in the library documentation.

- Unisec::Bidi
- Unisec::Blocks
- Unisec::Confusables
- Unisec::Decdump
- Unisec::Hexdump
- Unisec::Normalization
- Unisec::Planes
- Unisec::Properties
- Unisec::Rugrep
- Unisec::Size
- Unisec::Surrogates
- Unisec::Versions