| Name | man2text JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Convert system manpages to plain UTF-8 text files (English-only by default). |
| upload_time | 2025-09-13 17:42:00 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# man2text
`man2text` is a Python library and CLI tool that converts all system **man pages** into clean, plain text files.
This makes it easy to index, vectorize, or otherwise process Unix documentation.
> [!NOTE]
> This is the very first version of `man2text`. Any contributions are appreciated!
## Features
- Converts all available English manpages (`/usr/share/man/man*`) into `.txt`.
- Uses the standard `man <cmd> | col -bx` pipeline for accurate rendering.
- Optional multiprocessing for faster conversion on large systems.
- Provides both a **CLI command** and a **Python API**.
## Installation
Clone and install locally in editable mode:
```bash
git clone https://github.com/yourusername/man2text.git
cd man2text
pip install -e .
````
Or using `pip`:
```bash
pip install man2text
```
## Usage
### CLI
Convert all manpages to text and save them in `./man-txt`:
```bash
man2text --output ./man-txt
```
Options:
* `--output DIR` → output directory (default: `./man-txt`)
* `--processes N` → number of processes to use (default: auto)
### Python API
```python
from man2text.core import convert_all
# Convert all manpages to ./txt-pages with 4 processes
convert_all(output_dir="./txt-pages", processes=4)
```
## Example Output
For example, the `ls` manpage will produce `ls.txt` containing the plain text version of the manual page.
## Development
Build the project locally:
```bash
python -m build
```
Raw data
{
"_id": null,
"home_page": null,
"name": "man2text",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/29/22/00592ac1e4e80a0ad869dce7164e2162b09eba22db7eb51dd9b530c88722/man2text-0.0.1.tar.gz",
"platform": null,
"description": "# man2text\n\n`man2text` is a Python library and CLI tool that converts all system **man pages** into clean, plain text files. \nThis makes it easy to index, vectorize, or otherwise process Unix documentation.\n\n> [!NOTE] \n> This is the very first version of `man2text`. Any contributions are appreciated!\n\n\n## Features\n- Converts all available English manpages (`/usr/share/man/man*`) into `.txt`.\n- Uses the standard `man <cmd> | col -bx` pipeline for accurate rendering.\n- Optional multiprocessing for faster conversion on large systems.\n- Provides both a **CLI command** and a **Python API**.\n\n\n## Installation\n\nClone and install locally in editable mode:\n\n```bash\ngit clone https://github.com/yourusername/man2text.git\ncd man2text\npip install -e .\n````\n\nOr using `pip`:\n\n```bash\npip install man2text\n```\n\n\n## Usage\n\n### CLI\n\nConvert all manpages to text and save them in `./man-txt`:\n\n```bash\nman2text --output ./man-txt\n```\n\nOptions:\n\n* `--output DIR` \u2192 output directory (default: `./man-txt`)\n* `--processes N` \u2192 number of processes to use (default: auto)\n\n### Python API\n\n```python\nfrom man2text.core import convert_all\n\n# Convert all manpages to ./txt-pages with 4 processes\nconvert_all(output_dir=\"./txt-pages\", processes=4)\n```\n\n\n## Example Output\n\nFor example, the `ls` manpage will produce `ls.txt` containing the plain text version of the manual page.\n\n\n## Development\n\nBuild the project locally:\n\n```bash\npython -m build\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Convert system manpages to plain UTF-8 text files (English-only by default).",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/udqy/man2text"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "31a7089ca3c0745ca029c159c61b3c6df0196aff9ae1ca29d593a7da62f3c669",
"md5": "dc7bc1e0b79cd94c34017faa5b37c289",
"sha256": "4c0b3f50827b224bf1063324d1542b6f5632edab4dc836c5734150d5507ee4e1"
},
"downloads": -1,
"filename": "man2text-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc7bc1e0b79cd94c34017faa5b37c289",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8569,
"upload_time": "2025-09-13T17:41:59",
"upload_time_iso_8601": "2025-09-13T17:41:59.695257Z",
"url": "https://files.pythonhosted.org/packages/31/a7/089ca3c0745ca029c159c61b3c6df0196aff9ae1ca29d593a7da62f3c669/man2text-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "292200592ac1e4e80a0ad869dce7164e2162b09eba22db7eb51dd9b530c88722",
"md5": "89d7d6861725382573a8f123643587f5",
"sha256": "7caa67ea12c7dde2e35861f676a0c8fc6e8274d9a910a1f95f6a2e7769366b9b"
},
"downloads": -1,
"filename": "man2text-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "89d7d6861725382573a8f123643587f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7763,
"upload_time": "2025-09-13T17:42:00",
"upload_time_iso_8601": "2025-09-13T17:42:00.891468Z",
"url": "https://files.pythonhosted.org/packages/29/22/00592ac1e4e80a0ad869dce7164e2162b09eba22db7eb51dd9b530c88722/man2text-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-13 17:42:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "udqy",
"github_project": "man2text",
"github_not_found": true,
"lcname": "man2text"
}
