### Output of the example document

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/sample-bxcjkjatype-beamer.pdf

The output of the example document.

```text
私のホバークラフトは鰻でいっぱいです。
```

--------------------------------

### \UTF

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Inputs a CJK character through a Unicode codepoint value. For example, \UTF{5B57} is equivalent to \Unicode{"5B}{"57}.

```APIDOC
## \UTF

### Description
Inputs a CJK character through a Unicode codepoint value. For example, \UTF{5B57} is equivalent to \Unicode{"5B}{"57}.

### Usage
\UTF{<hexadecimal-number>}

### Parameters
- **<hexadecimal-number>** (string) - Required - The Unicode codepoint in hexadecimal notation.

### Notes
- The argument must be a hexadecimal number.
```

--------------------------------

### Redefine CJKecglue for shibuaki space

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Example of redefining \CJKecglue to adjust the shibuaki space value, similar to redefining \CJKglue for inter-ideographic space.

```latex
\renewcommand{\CJKecglue}{\hspace{0.125em minus 0.125em}}
```

--------------------------------

### \CJKinput

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Inputs a CJK character through Unicode codepoint value. For example, \CJKinput{5B57} is equivalent to \CJKchar"5B57.

```APIDOC
## \CJKinput{hexadecimal-number}

### Description
Inputs a CJK character through Unicode codepoint value. For example, \CJKinput{5B57} is equivalent to \CJKchar"5B57.

### Parameters
- **hexadecimal-number** (string) - Required - The Unicode codepoint value in hexadecimal.

### Usage Example
\CJKinput{5B57}

```

--------------------------------

### Write Japanese text in document body

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/sample-bxcjkjatype-beamer.pdf

Write Japanese text in the document body. Use UTF-8 encoding. The example shows a sentence using hiragana, katakana, and kanji.

```latex
\documentclass[a4paper]{article}
\usepackage[whole]{bxcjkjatype}
\begin{document}
私のホバークラフトは鰻でいっぱいです。
\end{document}
```

--------------------------------

### Load bxcjkvert package with options

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkvert.tex

Loads the bxcjkvert package, which automatically loads the CJKvert package if not already loaded. Options configure font reset, baseline stretch adjustment, and initial writing direction.

```latex
\usepackage[<option>,...]{bxcjkvert}
```

--------------------------------

### Package loading with options

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Load the bxcjkjatype package with a comma-separated list of options. Options control auto-wrapping, auto-tilde, PDF string handling, font mapping, and scaling.

```latex
\usepackage[<option>,...]{bxcjkjatype}
```

--------------------------------

### Compile with pdflatex

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/sample-bxcjkjatype-beamer.pdf

Compile the document as usual with pdflatex.

```bash
pdflatex sample.tex
```

--------------------------------

### uCJK* environment

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Shorthand for \begin{CJK*}{UTF8}{<counterpart>}...\end{CJK*}, where <counterpart> is the counterpart of the current alphabetic font family. Note that this is not equivalent to using an empty family argument, which would use the default CJK family.

```APIDOC
## uCJK* environment

### Description
Shorthand for \begin{CJK*}{UTF8}{<counterpart>}...\end{CJK*}, where <counterpart> is the counterpart of the current alphabetic font family. Note that this is not equivalent to using an empty family argument, which would use the default CJK family.

### Usage
\begin{uCJK*}
...
\end{uCJK*}

### Notes
- No arguments.
- The counterpart is determined by the current alphabetic font family.
```

--------------------------------

### CJK* environment

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

The CJK* environment is used to typeset CJK characters. The shorthand forms are equivalent to \begin{CJK*}{UTF8}{<counterpart>}...\end{CJK*}.

```APIDOC
## CJK* environment

### Description
The CJK* environment is used to typeset CJK characters. The shorthand forms are equivalent to \begin{CJK*}{UTF8}{<counterpart>}...\end{CJK*}.

### Usage Example
\begin{CJK*}{UTF8}{mc}
...
\end{CJK*}

```

--------------------------------

### uCJK* environment not equivalent to CJK* with empty family

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Shows the structure that uses the default CJK family, which is not equivalent to the uCJK* environment.

```latex
\begin{CJK*}{UTF8}{}...\end{CJK*}
```

--------------------------------

### uCJK environment

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Shorthand for \begin{CJK}{UTF8}{<counterpart>}...\end{CJK}, where <counterpart> is the counterpart of the current alphabetic font family.

```APIDOC
## uCJK environment

### Description
Shorthand for \begin{CJK}{UTF8}{<counterpart>}...\end{CJK}, where <counterpart> is the counterpart of the current alphabetic font family.

### Usage
\begin{uCJK}
...
\end{uCJK}

### Notes
- No arguments.
- The counterpart is determined by the current alphabetic font family.
```

--------------------------------

### uCJK* environment equivalent to CJK* with counterpart

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Shorthand for the CJK* environment that uses the counterpart of the current alphabetic font family, not the default CJK family.

```latex
\begin{CJK*}{UTF8}{<counterpart>}...\end{CJK*}
```

--------------------------------

### CJK environment

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

The CJK environment is used to typeset CJK characters. The shorthand forms are equivalent to \begin{CJK}{UTF8}{counterpart}...\end{CJK}.

```APIDOC
## CJK environment

### Description
The CJK environment is used to typeset CJK characters. The shorthand forms are equivalent to \begin{CJK}{UTF8}{counterpart}...\end{CJK}.

### Usage Example
\begin{CJK}{UTF8}{mc}
...
\end{CJK}

```

--------------------------------

### \gtfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Switches the CJK family to the Gothic family. Equivalent to \CJKfamily{\gtdefault}.

```APIDOC
## \gtfamily

### Description
Switches the CJK family to the Gothic family. Equivalent to \CJKfamily{\gtdefault}.

### Usage
\gtfamily

### Notes
- No arguments.
- Changes the current CJK family to the Gothic family.
```

--------------------------------

### Load bxcjkjatype package with whole option

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/sample-bxcjkjatype-beamer.tex

Use this LaTeX preamble to load the bxcjkjatype package with the 'whole' option, which is often suitable for Japanese documents. Place it in the document preamble before writing Japanese text.

```latex
\documentclass[a4paper]{article}
\usepackage[whole]{bxcjkjatype}
```

--------------------------------

### \mgfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Switches the CJK family to the Maru-gothic family. Equivalent to \CJKfamily{\mgdefault}.

```APIDOC
## \mgfamily

### Description
Switches the CJK family to the Maru-gothic family. Equivalent to \CJKfamily{\mgdefault}.

### Usage
\mgfamily

### Notes
- No arguments.
- Changes the current CJK family to the Maru-gothic family.
```

--------------------------------

### uCJK environment equivalent to CJK with counterpart

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Shorthand for the CJK environment that uses the counterpart of the current alphabetic font family.

```latex
\begin{CJK}{UTF8}{counterpart}...\end{CJK}
```

--------------------------------

### \setboldminchofont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the bold weight of the Mincho family. Usage is the same as in the pxchfon package.

```APIDOC
## \setboldminchofont

### Description
Sets the font file for the bold weight of the Mincho family. Usage is the same as in the pxchfon package.

### Usage
\setboldminchofont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \mcdefault, \gtdefault, \mgdefault

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Provide the names of the CJK families corresponding to the three generic families. In the standard allocation, their values are mc, gt, and mg respectively.

```APIDOC
## \mcdefault, \gtdefault, \mgdefault

### Description
Provide the names of the CJK families corresponding to the three generic families. In the standard allocation, their values are mc, gt, and mg respectively.

### Usage
\mcdefault
\gtdefault
\mgdefault

### Notes
- These are macros that expand to the family names.
```

--------------------------------

### \mcfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Switches the CJK family to the Mincho family. Equivalent to \CJKfamily{\mcdefault}.

```APIDOC
## \mcfamily

### Description
Switches the CJK family to the Mincho family. Equivalent to \CJKfamily{\mcdefault}.

### Usage
\mcfamily

### Notes
- No arguments.
- Changes the current CJK family to the Mincho family.
```

--------------------------------

### \CJKreset

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Changes the CJK family to the default CJK family that is specified by the \CJKdefaultfamily command.

```APIDOC
## \CJKreset

### Description
Changes the CJK family to the default CJK family that is specified by the \CJKdefaultfamily command.

### Usage Example
\CJKreset

```

--------------------------------

### \rmfamily, \sffamily, \ttfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Redefined commands that change the CJK family to the counterpart of the alphabetic font family after executing the original function. The counterparts are: \rmfamily (Serif) -> \mcfamily (Mincho), \sffamily (Sans-serif) -> \gtfamily (Gothic), \ttfamily (Monospace) -> \gtfamily (Gothic).

```APIDOC
## \rmfamily, \sffamily, \ttfamily

### Description
Redefined commands that change the CJK family to the counterpart of the alphabetic font family after executing the original function. The counterparts are: \rmfamily (Serif) -> \mcfamily (Mincho), \sffamily (Sans-serif) -> \gtfamily (Gothic), \ttfamily (Monospace) -> \gtfamily (Gothic).

### Usage
\rmfamily
\sffamily
\ttfamily

### Notes
- No arguments.
- These commands switch the CJK family to the counterpart of the current alphabetic family.
```

--------------------------------

### \setminchofont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the Mincho family. Usage is the same as in the pxchfon package.

```APIDOC
## \setminchofont

### Description
Sets the font file for the Mincho family. Usage is the same as in the pxchfon package.

### Usage
\setminchofont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \setboldgothicfont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the bold weight of the Gothic family. Usage is the same as in the pxchfon package.

```APIDOC
## \setboldgothicfont

### Description
Sets the font file for the bold weight of the Gothic family. Usage is the same as in the pxchfon package.

### Usage
\setboldgothicfont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \setxboldgothicfont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the extra bold weight of the Gothic family. Usage is the same as in the pxchfon package.

```APIDOC
## \setxboldgothicfont

### Description
Sets the font file for the extra bold weight of the Gothic family. Usage is the same as in the pxchfon package.

### Usage
\setxboldgothicfont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \setgothicfont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the Gothic family. Usage is the same as in the pxchfon package.

```APIDOC
## \setgothicfont

### Description
Sets the font file for the Gothic family. Usage is the same as in the pxchfon package.

### Usage
\setgothicfont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \CJKsffamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Changes the CJK family to the Gothic family. Equivalent to \CJKfamily{gt}.

```APIDOC
## \CJKsffamily

### Description
Changes the CJK family to the Gothic family. Equivalent to \CJKfamily{gt}.

### Usage Example
\CJKsffamily

```

--------------------------------

### \CJKttfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Changes the CJK family to the Maru-gothic family. Equivalent to \CJKfamily{mg}.

```APIDOC
## \CJKttfamily

### Description
Changes the CJK family to the Maru-gothic family. Equivalent to \CJKfamily{mg}.

### Usage Example
\CJKttfamily

```

--------------------------------

### \CJKrmfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Changes the CJK family to the Mincho family. Equivalent to \CJKfamily{mc}.

```APIDOC
## \CJKrmfamily

### Description
Changes the CJK family to the Mincho family. Equivalent to \CJKfamily{mc}.

### Usage Example
\CJKrmfamily

```

--------------------------------

### \normalfont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Changes the CJK family to the default CJK family that is specified by the \setCJKfamilydefault command.

```APIDOC
## \normalfont

### Description
Changes the CJK family to the default CJK family that is specified by the \setCJKfamilydefault command.

### Usage
\normalfont

### Notes
- No arguments.
- The default CJK family is set via \setCJKfamilydefault.
```

--------------------------------

### \CJKunforce

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Cancels the effect of the \CJKforce command.

```APIDOC
## \CJKunforce

### Description
Cancels the effect of the \CJKforce command.

### Usage
\CJKunforce{<character>...}

### Parameters
- **<character>...** (string) - Required - One or more characters for which the CJK forcing is canceled.

### Notes
- This reverses the effect of \CJKforce.
```

--------------------------------

### \CJKforce

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Afterwards treats the characters given in the argument as CJK characters (printed using CJK fonts).

```APIDOC
## \CJKforce

### Description
Afterwards treats the characters given in the argument as CJK characters (printed using CJK fonts).

### Usage
\CJKforce{<character>...}

### Parameters
- **<character>...** (string) - Required - One or more characters to be treated as CJK.

### Notes
- The effect persists until canceled by \CJKunforce.
```

--------------------------------

### \setmediumminchofont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the medium weight of the Mincho family. Usage is the same as in the pxchfon package.

```APIDOC
## \setmediumminchofont

### Description
Sets the font file for the medium weight of the Mincho family. Usage is the same as in the pxchfon package.

### Usage
\setmediumminchofont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \CJKchar

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Afterwards treats the characters given in the argument as CJK characters (printed using CJK fonts).

```APIDOC
## \CJKchar{character}

### Description
Afterwards treats the characters given in the argument as CJK characters (printed using CJK fonts).

### Parameters
- **character** (string) - Required - The character(s) to be treated as CJK.

### Usage Example
\CJKchar{漢}

```

--------------------------------

### \CJKfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Changes the CJK family to the specified family. This command is used to select the CJK font family for subsequent text.

```APIDOC
## \CJKfamily{family}

### Description
Changes the CJK family to the specified family. This command is used to select the CJK font family for subsequent text.

### Parameters
- **family** (string) - Required - The name of the CJK family to switch to.

### Usage Example
\CJKfamily{mc}

```

--------------------------------

### \@ (with non-ASCII character)

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Treats the next character (only that occurrence) as a CJK character, when the character is outside the ASCII range; otherwise the standard meaning of \@ is retained.

```APIDOC
## \@ (with non-ASCII character)

### Description
Treats the next character (only that occurrence) as a CJK character, when the character is outside the ASCII range; otherwise the standard meaning of \@ is retained.

### Usage
\@<character>

### Parameters
- **<character>** (string) - Required - The character to be treated as CJK (only if non-ASCII).

### Notes
- Only affects the immediately following character.
```

--------------------------------

### \setmediumgothicfont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the medium weight of the Gothic family. Usage is the same as in the pxchfon package.

```APIDOC
## \setmediumgothicfont

### Description
Sets the font file for the medium weight of the Gothic family. Usage is the same as in the pxchfon package.

### Usage
\setmediumgothicfont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \setmarugothicfont

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Sets the font file for the Maru-gothic family. Usage is the same as in the pxchfon package.

```APIDOC
## \setmarugothicfont

### Description
Sets the font file for the Maru-gothic family. Usage is the same as in the pxchfon package.

### Usage
\setmarugothicfont{<id>}{<font-file>}

### Parameters
- **<id>** (string) - Required - Identifier for the font mapping.
- **<font-file>** (string) - Required - Path to the font file.

### Notes
- With pdfTeX, only TrueType fonts are allowed, and TTC format is not allowed. With dvipdfmx, any OpenType flavor is allowed.
```

--------------------------------

### \CJKecglue

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Inserts a 'shibuaki' space. This will be invoked by ~ when \CJKtilde is in effect. This command can be redefined by users to adjust the value of shibuaki space, just as \CJKglue can be redefined to adjust inter-ideographic space.

```APIDOC
## \CJKecglue

### Description
Inserts a 'shibuaki' space. This will be invoked by ~ when \CJKtilde is in effect. This command can be redefined by users to adjust the value of shibuaki space, just as \CJKglue can be redefined to adjust inter-ideographic space.

### Usage
\CJKecglue

### Notes
- Can be redefined, e.g., \renewcommand{\CJKecglue}{\hspace{0.125em minus 0.125em}}.
```

--------------------------------

### \CJKunichar

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Cancels the effect of the \CJKchar command.

```APIDOC
## \CJKunichar{character}

### Description
Cancels the effect of the \CJKchar command.

### Parameters
- **character** (string) - Required - The character(s) to be treated as non-CJK.

### Usage Example
\CJKunichar{漢}

```

--------------------------------

### \CJKrm / \CJKsf / \CJKtt

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Changes the CJK family to the counterpart of the alphabetic font family after executing the original function.

```APIDOC
## \CJKrm / \CJKsf / \CJKtt

### Description
Changes the CJK family to the counterpart of the alphabetic font family after executing the original function.

### Usage Example
\CJKrm

```

--------------------------------

### \CJKmc / \CJKgt / \CJKmg

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

The names of CJK families corresponding to the three generic families. In the standard allocation their values are mc, gt, and mg respectively.

```APIDOC
## \CJKmc / \CJKgt / \CJKmg

### Description
The names of CJK families corresponding to the three generic families. In the standard allocation their values are mc, gt, and mg respectively.

### Usage Example
\CJKmc

```

--------------------------------

### \CJKdefaultfamily

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.tex

Declares the default CJK family. This default value is used when family names are missing in some commands, such as \CJKfamily and UTF8.

```APIDOC
## \CJKdefaultfamily{family}

### Description
Declares the default CJK family. This default value is used when family names are missing in some commands, such as \CJKfamily and UTF8.

### Parameters
- **family** (string) - Required - The name of the CJK family to set as default.

### Usage Example
\CJKdefaultfamily{mc}

```

--------------------------------

### \setCJKfamilydefault

Source: https://github.com/zr-tex8r/bxcjkjatype/blob/master/bxcjkjatype.pdf

Declares the default CJK family. This default value is used when family names are missing in some commands, such as \CJKfamily{} and \begin{CJK}{UTF8}{}. The (redefined) \normalfont also switches the CJK family to the family specified by this command.

```APIDOC
## \setCJKfamilydefault

### Description
Declares the default CJK family. This default value is used when family names are missing in some commands, such as \CJKfamily{} and \begin{CJK}{UTF8}{}. The (redefined) \normalfont also switches the CJK family to the family specified by this command.

### Usage
\setCJKfamilydefault{<CJK-family>}

### Parameters
- **<CJK-family>** (string) - Required - The name of the CJK family to set as default.

### Notes
- The default value of this default family is the counterpart of the alphabetic font family in effect at the beginning of the document body.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.