{"id":26036670,"url":"https://github.com/tldr-pages/tldr-cpp-client","last_synced_at":"2025-03-07T08:01:08.952Z","repository":{"id":16413445,"uuid":"19164527","full_name":"tldr-pages/tldr-c-client","owner":"tldr-pages","description":"C command-line client for tldr pages","archived":false,"fork":false,"pushed_at":"2024-05-01T08:35:26.000Z","size":175,"stargazers_count":296,"open_issues_count":12,"forks_count":49,"subscribers_count":12,"default_branch":"main","last_synced_at":"2024-08-10T01:06:46.816Z","etag":null,"topics":["c","hacktoberfest","linux","macos","tldr","tldr-pages"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"oguzhantopgul/cve-2015-1538-1","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tldr-pages.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"liberapay":"tldr-pages"}},"created_at":"2014-04-26T00:11:06.000Z","updated_at":"2024-08-10T01:06:49.406Z","dependencies_parsed_at":"2024-08-10T01:17:39.816Z","dependency_job_id":null,"html_url":"https://github.com/tldr-pages/tldr-c-client","commit_stats":null,"previous_names":["tldr-pages/tldr-cpp-client"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftldr-c-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftldr-c-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftldr-c-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tldr-pages%2Ftldr-c-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tldr-pages","download_url":"https://codeload.github.com/tldr-pages/tldr-c-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242353780,"owners_count":20114042,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","hacktoberfest","linux","macos","tldr","tldr-pages"],"created_at":"2025-03-07T08:00:33.561Z","updated_at":"2025-03-07T08:01:08.921Z","avatar_url":"https://github.com/tldr-pages.png","language":"C","readme":"# tldr c client\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr-c-client/.github/workflows/tests.yml?branch=main)](https://github.com/tldr-pages/tldr-c-client/actions)\n\n\u003e [!WARNING]\n\u003e _**This client is currently unmaintained.**_\n\u003e It lacks features that other official clients have (e.g. translation support).\n\u003e Consider using the [Node.js](https://github.com/tldr-pages/tldr-node-client), [Python](https://github.com/tldr-pages/tldr-python-client) or [Rust](https://github.com/tldr-pages/tlrc) client instead.\n\nA command line client for tldr, written in plain ISO C90.\n\n## Installing\n\nOn OS X, the client can be installed through [Homebrew](http://brew.sh/).\n\n```sh\n# To install the latest development version\nbrew install tldr --HEAD\n\n# To install the latest stable release\nbrew install tldr\n```\n\nOn Arch Linux, the client can be installed through [the AUR](https://aur.archlinux.org/packages/tldr-git) using an AUR helper such as yay.\n\n```sh\nyay -S tldr-git\n```\n\nTo build the latest version from the source:\n\n```sh\ngit clone https://github.com/tldr-pages/tldr-c-client.git\ncd tldr-c-client\n\nsudo ./deps.sh           # install dependencies\nmake                # build tldr\nsudo make install        # install tldr\n```\n\nTo remove the version installed from the source:\n\n```sh\nsudo make uninstall\n```\n\nThe default prefix for installation is `/usr/local/bin`.\n\n\n## Building\n\nBuilding the `tldr` client is pretty straightforward.\n\n### Requirements\n\n- `clang`/`gcc`\n- `libcurl` (`brew install curl` / `apt-get install libcurl-dev` / `apt-get install libcurl4-openssl-dev`)\n- `libzip` (`brew install libzip` / `apt-get install libzip-dev`)\n- `pkg-config` (`brew install pkg-config` / `apt-get install pkg-config`)\n\n### Compiling\n\nThe [`Makefile`](https://github.com/tldr-pages/tldr-c-client/blob/master/Makefile)\nin the root directory has all you need for building the project.\n\nJust call `make` and `tldr` will build itself.\n\n```sh\nmake\n```\n\n## Autocompletion\n\nAutocompletion is supported for `bash`, `zsh`, and `fish` and can be added by sourcing\nthe correct autocompletion file.\n\nThe files `autocomplete.zsh`, `autocomplete.bash`, and `autocomplete.fish` can be found in the `autocomplete`\nfolder in the root of the repository.\n\n### Installation\n\nTo install the autocompletion, just move the script for your shell to an easy\nto access the directory (like your home directory), and source it in your `.bashrc` or `.zshrc`.\n\nExample for zsh:\n\n```sh\nmv autocomplete/complete.zsh ~/.tldr.complete\necho \"source ~/.tldr.complete\" \u003e\u003e ~/.zshrc\n```\n\n## Usage\n\n```sh\nusage: tldr [OPTION]... PAGE\n\navailable commands:\n    -h, --help              print this help and exit\n    -C, --color             force color display\n    -p, --platform=PLATFORM select platform, supported are linux / osx / sunos / windows / common\n    -r, --render=PATH       render a local page for testing purposes\n    -u, --update            update local database\n    -v, --version           print version and exit\n    -c, --clear-cache       clear local database\n    -V, --verbose           display verbose output (when used with --clear-cache or --update)\n    -l, --list              list all entries in the local database\n```\n\n## Configuration\n\nTo prevent `tldr` from automatically updating its database, set the environment variable `TLDR_AUTO_UPDATE_DISABLED`.\n\n## Contributing\n\nPlease read the [CONTRIBUTING.md](https://github.com/tldr-pages/tldr-c-client/blob/master/CONTRIBUTING.md) for details.\n\n## License\n\nThe MIT License (MIT) - see [LICENSE](https://github.com/tldr-pages/tldr-c-client/blob/master/LICENSE) for details.\n","funding_links":["https://liberapay.com/tldr-pages"],"categories":["Install Vundle"],"sub_categories":["Caveats"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldr-pages%2Ftldr-cpp-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftldr-pages%2Ftldr-cpp-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftldr-pages%2Ftldr-cpp-client/lists"}