Forums

Skip to content

Advanced search
  • Quick links
    • Unanswered topics
    • Active topics
    • Search
  • FAQ
  • Login
  • Register
  • Board index Discussion & Documentation Gentoo Chat
  • Search

Documentation reader?

Opinions, ideas and thoughts about Gentoo. Anything and everything about Gentoo except support questions.
Post Reply
  • Print view
Advanced search
11 posts • Page 1 of 1
Author
Message
leyvi
l33t
l33t
Posts: 719
Joined: Fri Sep 08, 2023 1:22 pm

Documentation reader?

  • Quote

Post by leyvi » Thu Dec 11, 2025 3:24 pm

I'm tired of using less to read (among other things) the kernel documentation, and the contents of /usr/share/doc. What do you guys recommend?
Top
pingtoo
Advocate
Advocate
User avatar
Posts: 2182
Joined: Fri Sep 10, 2021 8:37 pm
Location: Richmond Hill, Canada

Re: Documentation reader?

  • Quote

Post by pingtoo » Thu Dec 11, 2025 3:39 pm

leyvi wrote:I'm tired of using less to read (among other things) the kernel documentation, and the contents of /usr/share/doc. What do you guys recommend?
Does browser url: file:///usr/share/doc/ work for you?
Top
leyvi
l33t
l33t
Posts: 719
Joined: Fri Sep 08, 2023 1:22 pm

Re: Documentation reader?

  • Quote

Post by leyvi » Thu Dec 11, 2025 3:53 pm

pingtoo wrote:
leyvi wrote:I'm tired of using less to read (among other things) the kernel documentation, and the contents of /usr/share/doc. What do you guys recommend?
Does browser url: file:///usr/share/doc/ work for you?
It does, but only for HTML. Thanks anyways, that's almost half of it.
Top
Hu
Administrator
Administrator
Posts: 24395
Joined: Tue Mar 06, 2007 5:38 am

  • Quote

Post by Hu » Thu Dec 11, 2025 3:58 pm

$EDITOR, commonly vim or emacs, but most advanced editors should suffice.
Top
pingtoo
Advocate
Advocate
User avatar
Posts: 2182
Joined: Fri Sep 10, 2021 8:37 pm
Location: Richmond Hill, Canada

Re: Documentation reader?

  • Quote

Post by pingtoo » Thu Dec 11, 2025 4:12 pm

leyvi wrote:
pingtoo wrote:
leyvi wrote:I'm tired of using less to read (among other things) the kernel documentation, and the contents of /usr/share/doc. What do you guys recommend?
Does browser url: file:///usr/share/doc/ work for you?
It does, but only for HTML. Thanks anyways, that's almost half of it.
Is the document you want to view is some sort of structured text or binary? Browser should always able to load and display Text document (ASCII or UTF8).

I don't think there is a document reader that can read any kind of file :D
Top
wjb
l33t
l33t
User avatar
Posts: 681
Joined: Sun Jul 10, 2005 9:40 am
Location: Fife, Scotland

  • Quote

Post by wjb » Thu Dec 11, 2025 11:27 pm

If kde, there's either khelpcenter, or with krunner it's just prefix with man: or info: e.g.

Code: Select all

man:ls
tkman if truly desperate (it's not pretty but it is gui)

and then there's what works reasonably well in most cases .... just google "man whatever" - you'll get a man file from somewhere, not exactly what you've got locally, but its usually fresh enough to do the job
Top
skellr
Veteran
Veteran
User avatar
Posts: 1037
Joined: Sat Jun 18, 2005 1:34 am
Location: The Village, Portmeirion

Re: Documentation reader?

  • Quote

Post by skellr » Thu Dec 11, 2025 11:34 pm

leyvi wrote:
pingtoo wrote:Does browser url: file:///usr/share/doc/ work for you?
It does, but only for HTML. Thanks anyways, that's almost half of it.
I used to use Firefox for reading logs, it was just convenient to open it in a browser tab...

I think once you install xdg-utils it changes the file type hanling and Firefox would only want to download a .log text file instead of displaying it.

This is probably the place to look if you want to pursue the web browser approach.

https://portland.freedesktop.org/doc/xdg-mime.html


I can't help you with this. I chose the lazy option of not installing xdg-utils. :)
Top
leyvi
l33t
l33t
Posts: 719
Joined: Fri Sep 08, 2023 1:22 pm

  • Quote

Post by leyvi » Sun Dec 21, 2025 10:48 am

There's this thing called Pandoc that can convert to/from most markup languages/formats. Would there be a way to tell Portage to generate HTML files from all installed documentation files matching a list of file types?
Top
flexibeast
l33t
l33t
Posts: 680
Joined: Mon Apr 04, 2022 4:15 am
Location: Naarm/Melbourne, Australia
Contact:
Contact flexibeast
Website

  • Quote

Post by flexibeast » Sun Dec 21, 2025 10:31 pm

Off the top of my head, you could hook into the postinst phase; refer to /etc/portage/bashrc page on the wiki for details. (i hook into the postinst phase as part of providing desktop notifications of emerge progress.)
https://wiki.gentoo.org/wiki/User:Flexibeast
My most recent wiki contributions
Top
flexibeast
l33t
l33t
Posts: 680
Joined: Mon Apr 04, 2022 4:15 am
Location: Naarm/Melbourne, Australia
Contact:
Contact flexibeast
Website

Re: Documentation reader?

  • Quote

Post by flexibeast » Sun Dec 21, 2025 10:43 pm

pingtoo wrote:I don't think there is a document reader that can read any kind of file :D
Emacs can read and format a number of them out of the box (OOTB), though. :) For example, man page support is provided by "WoMan"; HTML support, by "EWW"; and to quote the "DocView" documentation:
DocView mode is a major mode for viewing DVI, PostScript (PS), PDF, OpenDocument, Microsoft Office, EPUB, CBZ, FB2, XPS and OXPS documents. It provides features such as slicing, zooming, and searching inside documents. It works by converting the document to a set of images using the gs (GhostScript) or pdfdraw/mutool draw (MuPDF) commands and other external tools, and then displays those converted images.
Of course, this has obvious limitations in terms of accessibility and ability to copy-and-paste.

For those that aren't supported OOTB, there are often packages (e.g. on MELPA) which provide such support. (And sometimes there are packages seeking to provide improved support compared to what's available OOTB.)
https://wiki.gentoo.org/wiki/User:Flexibeast
My most recent wiki contributions
Top
leyvi
l33t
l33t
Posts: 719
Joined: Fri Sep 08, 2023 1:22 pm

  • Quote

Post by leyvi » Mon Dec 22, 2025 11:49 am

flexibeast wrote:Off the top of my head, you could hook into the postinst phase; refer to /etc/portage/bashrc page on the wiki for details. (i hook into the postinst phase as part of providing desktop notifications of emerge progress.)
Thanks, looks promising.
Top
Post Reply
  • Print view

11 posts • Page 1 of 1

Return to “Gentoo Chat”

Jump to
  • Assistance
  • ↳   News & Announcements
  • ↳   Frequently Asked Questions
  • ↳   Installing Gentoo
  • ↳   Multimedia
  • ↳   Desktop Environments
  • ↳   Networking & Security
  • ↳   Kernel & Hardware
  • ↳   Portage & Programming
  • ↳   Gamers & Players
  • ↳   Other Things Gentoo
  • ↳   Unsupported Software
  • Discussion & Documentation
  • ↳   Documentation, Tips & Tricks
  • ↳   Gentoo Chat
  • ↳   Gentoo Forums Feedback
  • ↳   Duplicate Threads
  • International Gentoo Users
  • ↳   中文 (Chinese)
  • ↳   Dutch
  • ↳   Finnish
  • ↳   French
  • ↳   Deutsches Forum (German)
  • ↳   Diskussionsforum
  • ↳   Deutsche Dokumentation
  • ↳   Greek
  • ↳   Forum italiano (Italian)
  • ↳   Forum di discussione italiano
  • ↳   Risorse italiane (documentazione e tools)
  • ↳   Polskie forum (Polish)
  • ↳   Instalacja i sprzęt
  • ↳   Polish OTW
  • ↳   Portuguese
  • ↳   Documentação, Ferramentas e Dicas
  • ↳   Russian
  • ↳   Scandinavian
  • ↳   Spanish
  • ↳   Other Languages
  • Architectures & Platforms
  • ↳   Gentoo on ARM
  • ↳   Gentoo on PPC
  • ↳   Gentoo on Sparc
  • ↳   Gentoo on Alternative Architectures
  • ↳   Gentoo on AMD64
  • ↳   Gentoo for Mac OS X (Portage for Mac OS X)
  • Board index
  • All times are UTC
  • Delete cookies

© 2001–2026 Gentoo Foundation, Inc.

Powered by phpBB® Forum Software © phpBB Limited

Privacy Policy

 

 

magic