{"id":13647580,"url":"https://github.com/dmbaturin/iproute2-cheatsheet","last_synced_at":"2025-04-04T10:09:47.706Z","repository":{"id":12976802,"uuid":"15655460","full_name":"dmbaturin/iproute2-cheatsheet","owner":"dmbaturin","description":"iproute2 command reference","archived":false,"fork":false,"pushed_at":"2024-08-29T18:40:07.000Z","size":366,"stargazers_count":438,"open_issues_count":10,"forks_count":91,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-03-28T09:09:13.395Z","etag":null,"topics":["hacktoberfest","html","iproute2","linux","network","network-admin"],"latest_commit_sha":null,"homepage":"https://baturin.org/docs/iproute2","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dmbaturin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2014-01-05T17:34:40.000Z","updated_at":"2025-03-22T03:57:29.000Z","dependencies_parsed_at":"2024-11-21T12:02:52.863Z","dependency_job_id":"241d1117-655b-412d-b50f-bf4f18f6295e","html_url":"https://github.com/dmbaturin/iproute2-cheatsheet","commit_stats":{"total_commits":135,"total_committers":23,"mean_commits":5.869565217391305,"dds":0.2518518518518519,"last_synced_commit":"0576384f7c60e5222a16d3ba751d22f96b5e929b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmbaturin%2Fiproute2-cheatsheet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmbaturin%2Fiproute2-cheatsheet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmbaturin%2Fiproute2-cheatsheet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmbaturin%2Fiproute2-cheatsheet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmbaturin","download_url":"https://codeload.github.com/dmbaturin/iproute2-cheatsheet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157283,"owners_count":20893220,"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":["hacktoberfest","html","iproute2","linux","network","network-admin"],"created_at":"2024-08-02T01:03:39.587Z","updated_at":"2025-04-04T10:09:47.675Z","avatar_url":"https://github.com/dmbaturin.png","language":"Lua","funding_links":[],"categories":["Lua"],"sub_categories":[],"readme":"Task-centered iproute2 user guide\n=================================\n\nThe `iproute2` package that contains `ip`, `bridge`, `tc`, and `ss` is now **the** Linux network management toolkit.\nNot only does it combine the functionality of the old `ifconfig`, `vconfig`, `route`, \nand other commands, it also supports networking features that the old tools still\ndo not support. Some examples of missing functionality are multiple addresses on the \nsame interface, policy-based routing, VRFs, network namespaces, and more.\n\nA major issue with the iproute2 package is its documentation. Its man pages are extremely terse:\nonly basic descriptions of the options and almost no examples.\nWhile for an experienced user, this level of documentation is enough, for most novice users, it is not.\nMany users continue using `ifconfig` out of habit and familiarity\nand ultimately miss out on the powerful features of the new tools.\n\nHistorically, community-maintained documentation such as http://policyrouting.org/iproute2-toc.html \nand https://www.lartc.org/howto/ filled the documentation void.\nUnfortunately, those classic documents were written in the early to mid-2000s and haven't been updated ever since.\nThey are still good for learning how to use old features but don't cover any new functionality.\nWorse yet, those documents aren't under free-culture licenses, so it's impossible to fork them\nand make updated versions without their original maintainers' consent.\n\nThis document aims to provide a comprehensive, easy-to-use, free (as in freedom) guide to iproute2 —\nat least its `ip` and `bridge` commands (documenting `tc` in this style would be a separate big project).\n\nOriginally this guide was named \"iproute2 cheatsheet\", but it has long outgrown the scope and size\nof a mere cheatsheet, so now it's named a \"Task-centered iproute2 user guide\".\n\n# Primary location and mirroring\n\nThe original and primary location of the document is https://baturin.org/docs/iproute2/\n\nThe page is bundled with all the JS, CSS, and images, so it's easy to mirror or save for local use.\n\n# Contributing\n\nPatches are always welcome. If you want to fix a typo, improve grammar or wording,\nor document a previously undocumented feature, please open a pull request or email me\na patch (use `git format-patch` please!).\n\nThe content source is in `site/index.md`.\n\nThe licenses under CC-BY-SA 4.0.\n\n## Contributing guidelines\n\nPlease use HTML headings with `id` attributes. Do not use Markdown headings.\nIn other words, use `\u003ch3 id=\"ip-link-frobnicate\"\u003eFrobnicate a link\u003c/h3\u003e`\nrather than `### Frobnicate a link`.\n\nThat allows section links to stay the same even if their wording changes or they are moved around the document.\nPeople _are_ sharing deep links to sections of this document page, so let's keep those links permanent.\n\n# Building\n\nThe manual page is built with [soupault](https://www.soupault.app) website generator/HTML processor.\n\nThis is how to build the page:\n\n* Install git — it's also used in the build process to generate the \"last modified\" timestamp.\n* Install soupault and [cmark](https://github.com/commonmark/cmark) on your system.\n* Run `soupault` in the project directory.\n* Find the generated page in `build/index.html`\n\nThis is what happens during the build process:\n\n* `site/index.md` is converted to HTML and inserted in the `\u003cmain\u003e` element of `templates/main.html`.\n* A table of contents is generated from the page headings (soupault's built-in functionality).\n* The table of contents `\u003cul\u003e` is converted to a foldable \"tree\" of HTML5 `\u003cdetails\u003e` elements using the `plugins/collapsible-list.lua` plugin.\n* CSS stylesheet and images are inlined using the `plugins/inline-assets.lua` plugin.\n* Last modification date is extracted from the git commit history and inserted into the page, using the `plugins/git-timestamp.lua` plugin.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmbaturin%2Fiproute2-cheatsheet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmbaturin%2Fiproute2-cheatsheet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmbaturin%2Fiproute2-cheatsheet/lists"}