{"id":16195130,"url":"https://github.com/ashcrow/iman","last_synced_at":"2025-09-02T11:09:30.466Z","repository":{"id":69246829,"uuid":"139264252","full_name":"ashcrow/iman","owner":"ashcrow","description":"Reading man pages from images","archived":false,"fork":false,"pushed_at":"2018-06-30T16:42:35.000Z","size":32,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-25T08:37:44.018Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ashcrow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2018-06-30T16:41:10.000Z","updated_at":"2018-07-02T16:09:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"a22a9cc6-64fb-4dfa-8f80-4af6759f34f3","html_url":"https://github.com/ashcrow/iman","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ashcrow/iman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashcrow%2Fiman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashcrow%2Fiman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashcrow%2Fiman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashcrow%2Fiman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ashcrow","download_url":"https://codeload.github.com/ashcrow/iman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashcrow%2Fiman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273272649,"owners_count":25076005,"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","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-10-10T08:26:21.155Z","updated_at":"2025-09-02T11:09:30.441Z","avatar_url":"https://github.com/ashcrow.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"iman\n====\nReading man pages from images\n\n**This is a quick POC**: If it ends up being a helpful idea it will be fleshed out to be more than exec'ing commands :-)\n\n\nIn a nutshell, this command:\n\n- Starts a container\n- Copies the help.1 from the containers root filesystem\n- Uses man to show the help file\n- Destroys the container\n\n\nExample\n-------\n```\n[steve@elpis iman]$ sudo ./iman image-helpgen:1.0\nIMAGE-HELPGEN(1)                                                                 May 2018                                                                IMAGE-HELPGEN(1)\n\nNAME\n       image-helpgen - Create container help pages\n\nDESCRIPTION\n       The image-helpgen command lets you create a container help page from either guided prompts or content from a Dockerfile. Output from image-helpgen is a help.md\n       file (in Markdown format) and/or a help.1 file (in manpage format) that describes the container, its uses, and possible security issues.\n\n       By placing the help.1 file in a container image's root directory (/help.1), it can be displayed by various container tools.\n\nUSAGE\n       image-helpgen \u003ccommand\u003e [args]\n\nOPTIONS\n       guide\n             Prompts for container image content (name, usage, etc.) and produces help.1 and help.md files.\n\n       dockerfile\n             Parses a Dockerfile and generates a help page template in Markdown format (help.md).\n\n       man\n             Generates container help page (help.1) in manpage format from a completed Markdown file (help.md).\n\n       version\n             Shows version information and exits.\n\nCONTAINER HELP PAGE\n       Whether using the guide or dockerfile option, the following sections are created in the resulting help page:\n\n       * NAME: The NAME line is constructed from the values of “LABEL name”  + “LABEL summary” values in the Dockerfile.\n\n       * DESCRIPTION: All commented lines (#) at the beginning of the Dockerfile are used as the help file’s DESCRIPTION. Add a line with just a # to have separate\n       paragraphs. A line not beginning with a comment character (#) ends the description.\n\n       * ENVIRONMENT VARIABLES: The variable name and default setting for all lines beginning with ENV in the Dockerfile are added to the ENVIRONMENT VARIABLES table.\n\n       * SECURITY IMPLICATIONS: The security implications section is made up of the following subsections:\n\n           * Ports: Port numbers on EXPOSE lines are added to the Ports table.\n           * Volumes: Directories listed on VOLUME lines are added to the Volumes table.\n           * Daemon: If “-d” is on the usage line, text notes the container runs as a daemon.\n           * Expected Capabilities: Each --cap-add on the usage line adds an entry to the capabilities table.\n\n       * SEE ALSO: The value of any “LABEL url” line from the Dockerfile is added to the SEE ALSO section.\n\n       * Headings and footers: The header is created from this Dockerfile information: \"LABEL name=\"  Month/Year \"LABEL name=\"(2) and the footer is created from: ”LABEL\n       maintainer” Container Image Pages “LABEL name=”(2)\n\nEXAMPLES\n           image-helpgen dockerfile -dockerfile Dockerfile\n                   # Creates a help.md file from the Dockerfile in the current directory\n                   # Descriptions need to be added manually (look for TODO lines)\n\n           image-helpgen guide\n             Image name: myownimage\n                   # Creates a help.md and help.1 file from content you input from prompts\n\n           image-helpgen man\n                   # Produces a help.1 file from the help.md file in the current directory\n\nFILES\n       /etc/image-helpgen/template.tpl\n             Template file used to create container help pages.\n\nSEE ALSO\n       https://github.com/ashcrow/image-helpgen\n\nSteve Milner                                                                  User Commands                                                              IMAGE-HELPGEN(1)\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashcrow%2Fiman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fashcrow%2Fiman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashcrow%2Fiman/lists"}