LinuxCommandLibrary

tldr-generate

Generate tldr pages from command documentation

TLDR

Remake the configuration file storing into a specific location

$ tlmgr generate --dest [output_file]
copy


Remake the configuration file using a local configuration file
$ tlmgr generate --localcfg [local_configuration_file]
copy


Run necessary programs after rebuilding configuration files
$ tlmgr generate --rebuild-sys
copy

SYNOPSIS

tldr-generate [options]

PARAMETERS

--help
    Display help information.

--version
    Display version information.

--source
    Specify the source URL of the tldr pages. This can be a local directory or a remote Git repository.

--target
    Specify the directory where the generated markdown files will be stored. If not provided, it uses the default tldr cache directory.

--no-update
    Skips the update process (does not download latest tldr pages).

DESCRIPTION

The `tldr-generate` command is used to generate Markdown files from the tldr pages, which are community-maintained, simplified and community-driven man pages. It downloads the latest tldr pages (usually from the GitHub repository), and formats them appropriately for local usage. This command allows you to access these simplified documentation pages directly from your terminal. It is particularly useful for beginners and those who need a quick reference guide for common commands. The generated files can then be used by tldr clients (like `tldr` command) to display the concise documentation in the terminal. The `tldr-generate` command streamlines the process of keeping local tldr pages updated.

CAVEATS

The `tldr-generate` command requires an internet connection to download the latest tldr pages from the default repository. If you are using a custom source, ensure that it is accessible. The generated files are simple markdown files which need a tldr client to use them.

USAGE EXAMPLE

To generate the tldr pages and store them in a specific directory:
tldr-generate --target /path/to/tldr/cache
To update the tldr pages from a git repository:
tldr-generate --source https://github.com/tldr-pages/tldr.git

SEE ALSO

tldr(1)

Copied to clipboard