Офлайновая документация, поиск по ней и навигация

Возник вопрос: а как всё это удобным образом каталогизировать, обновлять и искать по этому?

man man

Молодец. Что делать с доками, которых нет и не предвидится в man-формате ввиду его ограниченности?

Что делать с доками, которых нет и не предвидится в man-формате ввиду его ограниченности?

всякие CPP Reference, доки по Qt, Haddock и т.д.

Для этого точно хватит. Берешь и переписываешь в man.

grep

У меня на работе куча сервисов. Вместо того, чтобы ходить по гитлабу, я всё нужное себе склонировал и когда нужно ищу по именам файлов и содержимому.

zeal

О! Вот это похоже на то, что я хочу. Спасибо!

Я пока только входную хтмл страничку сверстал, чтобы быстро открывать разные скачанные доки и запинил в браузере. В некоторых доках уже есть свой встроенный поиск, но подозреваю свой индекс построить поверх всего этого было бы неплохо.

В кедах индексатор есть.

Конпеляешь скачанное HTML в CHM и наслаждаешься жизнью.

Я когда-то для зоопарка pdf/html/chm/txt/djv... пользовался Recoll.

Я пользуюсь программой Calibre. Только она для .pdf и .djvu в основном. А под HTML-и твои запускай локальный вебсервер, и на нём всё настраивай.

app-text/zeal

Когда в основном дереве стабилизируется, тогда и приходите

Сразу вспомнил диски по подписке MSDN. Винда, конечно, но сама документация была шикарна, и вся в офлайне! Это потом пошел регресс в сторону онлайна

У Борланда на рубеже 80-х и 90-х была очень неплохая справка, Турбо Паскаль можно было использовать, не прибегая к внешним источникам. Даже книжки типа Фаронова или Мизрохи появились позже.

Благодарю, достойно, начал пользоваться. Так заипался от этого лагающего шлака с неудобным поиском

Я наоборот от Zeal перешёл на devdocs.io. Неохота было выкачивать гигабайты доков.

html. С web-мордой.

Offline documentation browser

After installing Zeal go to Tools->Docsets, select the ones you want, and click the Download button.

O_o

man – это самый конченный формат для документации, устаревший еще в прошлом веке.

Приблизительно вот так выглядит текст, если ты решишь скопировать его из мана:

MAN(1)                                             Manual pager utils                                            MAN(1)

NAME
       man - an interface to the system reference manuals

SYNOPSIS
       man [man options] [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [man options] [section] term ...
       man -f [whatis options] page ...
       man -l [man options] file ...
       man -w|-W [man options] page ...

DESCRIPTION
       man is the system's manual pager.  Each page argument given to man is normally the name of a program, utility or
       function.   The  manual page associated with each of these arguments is then found and displayed.  A section, if
       provided, will direct man to look only in that section of the manual.  The default action is to search in all of
       the available sections following a pre-defined order (see DEFAULTS), and to show only the first page found, even
       if page exists in several sections.

man – это самый конченный формат для документации, устаревший еще в прошлом веке.

используй gnu info!

Ну да, так и выглядит. Ты хочешь сказать будто бы это плохо? По-моему так наоборот весьма удобный вид. Хотя формат ман-исходников конечно ужасный.

Так ты смотри на то, что после DESCRIPTION лол. В оригинале это выглядит так:

https://imgur.com/suQ42ne

Ну и? Так же и выглядит. В чём проблема?

click the Download button
O_o

А откуда ещё возьмётся готовая документация, сама напишется?
Давно пользуюсь Zeal, хотя и есть баги.
Самый раздражающий – повторная загрузка обновлений при двойном клике.

Это проблемы --pager=less для man, который по умолчанию, который хардкодит переносы строк под ширину терминала.

Можно использовать другой пейджер вместо less: more, cat, vimpager и тп

Спробуй заячий помет! qman — man page viewer здорового человека
Он — ядреный! Он проймет!
И куды целебней меду,
Хоть по вкусу и не мед.
Он на вкус хотя и крут,
И с него, бывает, мрут,
Но какие выживают –
Те до старости живут!..

То есть он выкачивает с исходных ресурсов и не хранит заранее скаченные у себя?

Чем это тогда лучше закладок в браузере или просто в speed dial?

Спасибо, полезное.

Ну и раз уж такое началось, то

https://tldr.sh/
https://tldr.inbrowser.app/

https://github.com/idank/explainshell
https://www.explainshell.com/

https://github.com/cheat/cheat

http://bropages.org/

https://cheat.sh/

Он скачивает tgz c https://kapeli.com/dash.
Фатальный недостаток Zeal в том, что он их распаковывает в ~/.local/share/Zeal/Zeal/docsets.

Чем это тогда лучше закладок в браузере или просто в speed dial?

Поиск удобнее.

Ты чавой-то не в себе! Вон и прыщик на губе! Ой, растратишь ты здоровье В политической борьбе!..

Фатальный недостаток Zeal в том, что он их распаковывает

У меня была идея написать конвертер этих tgz в файлы Zim, тогда их можно будет смотреть в Kiwix или GoldenDict. Сделал проще. :)
Попросил китайцев добавить поддержку docsets в goldendict-ng. Посмотрим, что ответят.

Его ресурсы ещё и от чужого сайта зависят? Мда….

Хоть бы зеркало сделали.

Хоть бы зеркало сделали.

Зачем? У Dash их 5-6 штук.

Возник вопрос: а как всё это удобным образом каталогизировать, обновлять и искать по этому?

Каталогизировать и искать по этому не надо. Документация языков и библиотек структурирована и гипертекстова, ты сразу открываешь то что тебе нужно. Обновлять это нужно так: просто ходишь за документацией в интернет, и не слушаешь голоса в голове, которые шепчут тебе неаргументированный бред

поймал себя на мысли
какое-то полное дно

Ну разве что ты уходишь в оффлайн по какой-то причине. Я бы в этом случае просто сделал cargo doc (причём уже будучи в offline) и получил документацию сразу всех зависимостей проекта. Кстати, даже с поиском. Как это в других экосистемах сделать даже не представляю. Кажется, даже с readthedocs нельзя архив скачать.

Я бы в этом случае просто сделал cargo doc (причём уже будучи в offline) и получил документацию сразу всех зависимостей проекта. Кстати, даже с поиском. Как это в других экосистемах сделать даже не представляю. Кажется, даже с readthedocs нельзя архив скачать.

Stanson ты был прав, фанаты ржавого и правда иногда подбешивают.

Его ресурсы ещё и от чужого сайта зависят?

Так это не его ресурсы. Zeal нужен, чтобы мы могли таскать доки у белых людей с маками. Это просто морда с поиском. Хорошо хоть так, сами то линуксоиды ничего сложнее манов не осилили.

Приблизительно вот так выглядит текст, если ты решишь скопировать его из мана:

Так если из браузера копипастить, тоже фигня какая-то получается. Так что man groff в помощь. Но соглашусь, что man это тот ещё копролит. Зато быстрый и всегда есть под рукой.

фанаты ржавого и правда иногда подбешивают

Ну у тебя rust в тэгах, иначе я бы про это и не писал. А чем это я тебя подбесил? Тем что в rust можно одной командой сгенерить всю нужную документацию? Ну извини, я же такой растовый фанат раста, только одним живу - пользователям нормальных языков нервы портить.

Ну у тебя rust в тэгах, иначе я бы про это и не писал.

В этом треде rust нет.

Тем что в rust можно одной командой сгенерить всю нужную документацию?

Это можно сделать много где. Но это документация лишь по API и около. Документацию, например, по самому языку rust и его синтаксису ты так не сгенеришь, она хранится отдельно.

Хуже того, утверждение

Каталогизировать и искать по этому не надо.

в корне неверно.

Чтобы что-то сгенериь, это нужно сначала определённым образом оформить.

В этом треде rust нет.

Там написано «и т.д.» так что есть.

Документацию, например, по самому языку rust и его синтаксису ты так не сгенеришь, она хранится отдельно.

Разве что. Ну, скачать один дополнительный репозиторий, а собирается она так же.

в корне неверно

Если твой уровень таков что ты не знаешь где в документации лежит то что тебе нужно, или ещё того хуже, не знаешь что тебе нужно, то боюсь оффлайном ты уже никак не отделаешься - тебе нужны будут чатгпт, форумчики, чатики и стековерфлоу.

Чтобы что-то сгенериь, это нужно сначала определённым образом оформить.

К чему ты это написал?

Это я к тому, что сколько ты cargo doc не вызывай,если документация не написана, она не сгенерируется из неоткуда.

Я спрашиваю, к чему ты это пишешь? Если документации нет то её нет, в этом топике обсуждается кейс когда она есть.

просто ходишь за документацией в интернет

Интернет нередко тормозит,а также подвержен внезапным блокировкам. А также сайты имеют привычку реорганизовываться и ссылки становятся не валидными. Так что постоянно нужная в работе документация должна таки храниться локально. Тут автор темы однозначно прав.

В Дебиане есть такая штука Recoll - умеет искать нужное в локальном файловом архиве. Конечно,имеет ограничения по понимаемым форматам.

Еще существует Google Desktop. Оно есть под линукс,но довольно старое и без исходников. Поэтому не знаю насколько сложно будет запустить это на современном линуксе.

Если твой уровень таков что ты не знаешь где в документации лежит то что тебе нужно, или ещё того хуже, не знаешь что тебе нужно, то боюсь оффлайном ты уже никак не отделаешься - тебе нужны будут чатгпт, форумчики, чатики и стековерфлоу.

Илитарии фчате! Все в машину! Кто не может запомнить названия всех 2819 классов и 30977 функций из Qt6, тот быдло!

Если она есть, то какая разница чем она генерится?