Reference documentation

Purpose

This section provides complete technical reference for all Cabriolet commands and APIs. Use this for detailed syntax, parameters, return values, and technical specifications.

References

Concepts

Reference documentation is organized for quick lookup of specific commands, methods, or specifications. Unlike guides that explain how to accomplish tasks, reference material documents what each component does and how to use it precisely.

Reference Categories

CLI Reference

CLI Reference

Complete documentation for all CLI commands:

API Reference

API Reference

Complete Ruby API documentation:

Format Specifications

Format Specifications

Technical format details:

Quick reference

Most common commands

Command Purpose Section

cabriolet list FILE

List CAB contents

CAB

cabriolet extract FILE

Extract CAB files

CAB

cabriolet create OUTPUT FILES

Create CAB archive

CAB

cabriolet expand FILE

Expand SZDD file

SZDD

cabriolet chm-extract FILE

Extract CHM file

CHM

Most common API methods

Method Purpose Section

CAB::Decompressor.new(file)

Open CAB for reading

CAB

decompressor.extract(dir)

Extract all files

CAB

decompressor.each_file

Iterate files

CAB

CAB::Compressor.new(options)

Create new CAB

CAB

compressor.add_file(path)

Add file to CAB

CAB

Navigation tips

By task:

  1. Know the command/method name → Use search or table of contents

  2. Know the format → Go to format’s CLI or API section

  3. Know the operation → Check CLI index or API index

By format:

  • CAB → CLI | API

  • CHM → CLI | API

  • SZDD → CLI | API

  • Others → See respective sections

Reference conventions

Command Syntax

Commands are documented using this syntax:

command [OPTIONS] REQUIRED [OPTIONAL]

Where:
  REQUIRED    Required parameter
  [OPTIONAL]  Optional parameter
  [OPTIONS]   Command options (flags)

API Signatures

Methods are documented with Ruby signatures:

def method_name(required_param, optional_param = default)
  # Returns: Description of return value
  # Raises: Exception types that may be raised
end

Examples

All reference entries include:

  • Syntax: Complete command or method signature

  • Parameters: Detailed parameter descriptions

  • Returns: Return values and types

  • Examples: Working code examples

  • Errors: Possible error conditions

Version information

This reference documents Cabriolet version 0.1.0. Features may vary in different versions.

Next steps

  • Browse CLI for command-line tools

  • Explore API for Ruby integration

  • Review Formats for technical details

Related sections

Bibliography

Table of contents