Skip to content

Kaned1as/Man-Man

Repository files navigation

Travis (.org) GitHub release (latest by date) F-Droid License GPLv3+

Android client for accessing API and content of www.mankier.com site

Basically this means that this is a convenient tool for any Linux enthusiast familiar with man pages. It provides a fast way to search, browse and save man pages on your android device.

Get it on F-Droid Get it on Google Play

Screenshots

search page One-liner search Contents

Features

  • Supports searching for a single command
  • Supports explaining command one-liners
  • Supports browsing and indexing of man chapters
  • Supports caching of man pages that were previously accessed
  • Supports loading and viewing troff files from local man archive

Donate

Patreon PayPal Liberapay

In progress

  • Page actions (multiple load to cache, cache purging, favorites etc.)

Updating

I consider this app as stable now, so if you want any additional features to be included, please create an enhancement issue here

Local archive

You may wonder what's the hosting from which local archive is taken. In fact, it's same old Github. Content of the archive is assembled just by zipping manpage directory of Archlinux at nearly 2016-08-16. The archive in question is accessible from here, application just downloads it if requested.

P.S. Regarding offline mode

While current implementation lacks some important features, I'd like to clarify on how to properly organize directory structure for this to work. Basically this is identical to how Linux distributions place their man files in /usr/share/man directory. The structure of directories you should point a scanner too should look like this:

├── man1
│   ├── chage.1.gz
│   ├── checkXML.1.gz
│   ├── checkXML5.1.gz
│   ├── expiry.1.gz
│   ├── gpasswd.1.gz
│   ├── swappo.1.gz
│   └── xml2pot.1.gz
├── man3
│   ├── getspnam.3.gz
│   └── shadow.3.gz
├── man5
│   ├── faillog.5.gz
│   └── suauth.5.gz
├── man6
│   └── kpat.6.gz
├── man7
│   ├── qt5options.7.gz
│   └── qtoptions.7.gz
└── man8
    ├── chgpasswd.8.gz
    ├── userdel.8.gz
    └── usermod.8.gz

Man Man will recursively scan all the nested dirs and find appropriate (i.e. gzipped TROFF format) files

License

Copyright (C) 2016-2020 Oleg `Kanedias` Chernovskiy

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.