How to run full text search on help pages offline (from Yelp / gnome-help or something other)?












5















I have both Ubuntu 16.04 LTS and Ubuntu 18.04 LTS installed.



I want to search for documentation and read it off-line (as it is included to the installed packages in /usr/share/help and other locations). As far I can understand it has three formats:




  • HTML - .page (dpkg -S .page | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 12 results)

  • DocBook - .docbook (dpkg -S .docbook | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 21 results)

  • ManPage (many from manpath = /usr/local/man:/usr/local/share/man:/usr/share/man)


These files are rendered by Yelp program (from yelp package) with executables yelp and gnome-help.



Notes:




  1. here on AskUbuntu was similar question about ScrollKeeper database (provided by rarian-compat package) without answer;


  2. there is a bug 726439 named "Search for document returns an Unknown error: 'URI xref:search=' could not be parsed" on LauchPad.net (from 2011 year) about broken(?) search in Yelp. If I press CtrlS to search searchterm in current version of Yelp it still returns




    Unknown Error

    The URI ‘xref:search=searchterm’ could not be parsed.





Of course I can run the grep over all these files, but is it possible to run such search from Yelp?










share|improve this question




















  • 1





    There are also info pages and actual .html files in the docs of some packages.

    – muru
    Jul 24 '18 at 9:52
















5















I have both Ubuntu 16.04 LTS and Ubuntu 18.04 LTS installed.



I want to search for documentation and read it off-line (as it is included to the installed packages in /usr/share/help and other locations). As far I can understand it has three formats:




  • HTML - .page (dpkg -S .page | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 12 results)

  • DocBook - .docbook (dpkg -S .docbook | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 21 results)

  • ManPage (many from manpath = /usr/local/man:/usr/local/share/man:/usr/share/man)


These files are rendered by Yelp program (from yelp package) with executables yelp and gnome-help.



Notes:




  1. here on AskUbuntu was similar question about ScrollKeeper database (provided by rarian-compat package) without answer;


  2. there is a bug 726439 named "Search for document returns an Unknown error: 'URI xref:search=' could not be parsed" on LauchPad.net (from 2011 year) about broken(?) search in Yelp. If I press CtrlS to search searchterm in current version of Yelp it still returns




    Unknown Error

    The URI ‘xref:search=searchterm’ could not be parsed.





Of course I can run the grep over all these files, but is it possible to run such search from Yelp?










share|improve this question




















  • 1





    There are also info pages and actual .html files in the docs of some packages.

    – muru
    Jul 24 '18 at 9:52














5












5








5


1






I have both Ubuntu 16.04 LTS and Ubuntu 18.04 LTS installed.



I want to search for documentation and read it off-line (as it is included to the installed packages in /usr/share/help and other locations). As far I can understand it has three formats:




  • HTML - .page (dpkg -S .page | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 12 results)

  • DocBook - .docbook (dpkg -S .docbook | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 21 results)

  • ManPage (many from manpath = /usr/local/man:/usr/local/share/man:/usr/share/man)


These files are rendered by Yelp program (from yelp package) with executables yelp and gnome-help.



Notes:




  1. here on AskUbuntu was similar question about ScrollKeeper database (provided by rarian-compat package) without answer;


  2. there is a bug 726439 named "Search for document returns an Unknown error: 'URI xref:search=' could not be parsed" on LauchPad.net (from 2011 year) about broken(?) search in Yelp. If I press CtrlS to search searchterm in current version of Yelp it still returns




    Unknown Error

    The URI ‘xref:search=searchterm’ could not be parsed.





Of course I can run the grep over all these files, but is it possible to run such search from Yelp?










share|improve this question
















I have both Ubuntu 16.04 LTS and Ubuntu 18.04 LTS installed.



I want to search for documentation and read it off-line (as it is included to the installed packages in /usr/share/help and other locations). As far I can understand it has three formats:




  • HTML - .page (dpkg -S .page | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 12 results)

  • DocBook - .docbook (dpkg -S .docbook | grep -E /usr/share/help | awk '{print $1}' | sort | uniq | wc -l returns 21 results)

  • ManPage (many from manpath = /usr/local/man:/usr/local/share/man:/usr/share/man)


These files are rendered by Yelp program (from yelp package) with executables yelp and gnome-help.



Notes:




  1. here on AskUbuntu was similar question about ScrollKeeper database (provided by rarian-compat package) without answer;


  2. there is a bug 726439 named "Search for document returns an Unknown error: 'URI xref:search=' could not be parsed" on LauchPad.net (from 2011 year) about broken(?) search in Yelp. If I press CtrlS to search searchterm in current version of Yelp it still returns




    Unknown Error

    The URI ‘xref:search=searchterm’ could not be parsed.





Of course I can run the grep over all these files, but is it possible to run such search from Yelp?







search documentation offline helpfile yelp






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited Oct 5 '18 at 13:19







N0rbert

















asked Jul 24 '18 at 9:42









N0rbertN0rbert

21.8k547102




21.8k547102








  • 1





    There are also info pages and actual .html files in the docs of some packages.

    – muru
    Jul 24 '18 at 9:52














  • 1





    There are also info pages and actual .html files in the docs of some packages.

    – muru
    Jul 24 '18 at 9:52








1




1





There are also info pages and actual .html files in the docs of some packages.

– muru
Jul 24 '18 at 9:52





There are also info pages and actual .html files in the docs of some packages.

– muru
Jul 24 '18 at 9:52










2 Answers
2






active

oldest

votes


















0














This is especially for man pages in Linux.



find -name "cp.1.gz"| xargs zcat





share|improve this answer
























  • What about `man -k yousearch| ?

    – solsTiCe
    Dec 18 '18 at 7:44



















0














Try:



yelp man:<command>


For example:



yelp man:cp





share|improve this answer























    Your Answer








    StackExchange.ready(function() {
    var channelOptions = {
    tags: "".split(" "),
    id: "89"
    };
    initTagRenderer("".split(" "), "".split(" "), channelOptions);

    StackExchange.using("externalEditor", function() {
    // Have to fire editor after snippets, if snippets enabled
    if (StackExchange.settings.snippets.snippetsEnabled) {
    StackExchange.using("snippets", function() {
    createEditor();
    });
    }
    else {
    createEditor();
    }
    });

    function createEditor() {
    StackExchange.prepareEditor({
    heartbeatType: 'answer',
    autoActivateHeartbeat: false,
    convertImagesToLinks: true,
    noModals: true,
    showLowRepImageUploadWarning: true,
    reputationToPostImages: 10,
    bindNavPrevention: true,
    postfix: "",
    imageUploader: {
    brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
    contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
    allowUrls: true
    },
    onDemand: true,
    discardSelector: ".discard-answer"
    ,immediatelyShowMarkdownHelp:true
    });


    }
    });














    draft saved

    draft discarded


















    StackExchange.ready(
    function () {
    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2faskubuntu.com%2fquestions%2f1058947%2fhow-to-run-full-text-search-on-help-pages-offline-from-yelp-gnome-help-or-som%23new-answer', 'question_page');
    }
    );

    Post as a guest















    Required, but never shown

























    2 Answers
    2






    active

    oldest

    votes








    2 Answers
    2






    active

    oldest

    votes









    active

    oldest

    votes






    active

    oldest

    votes









    0














    This is especially for man pages in Linux.



    find -name "cp.1.gz"| xargs zcat





    share|improve this answer
























    • What about `man -k yousearch| ?

      – solsTiCe
      Dec 18 '18 at 7:44
















    0














    This is especially for man pages in Linux.



    find -name "cp.1.gz"| xargs zcat





    share|improve this answer
























    • What about `man -k yousearch| ?

      – solsTiCe
      Dec 18 '18 at 7:44














    0












    0








    0







    This is especially for man pages in Linux.



    find -name "cp.1.gz"| xargs zcat





    share|improve this answer













    This is especially for man pages in Linux.



    find -name "cp.1.gz"| xargs zcat






    share|improve this answer












    share|improve this answer



    share|improve this answer










    answered Oct 5 '18 at 11:49









    Tohid TamboliTohid Tamboli

    79946




    79946













    • What about `man -k yousearch| ?

      – solsTiCe
      Dec 18 '18 at 7:44



















    • What about `man -k yousearch| ?

      – solsTiCe
      Dec 18 '18 at 7:44

















    What about `man -k yousearch| ?

    – solsTiCe
    Dec 18 '18 at 7:44





    What about `man -k yousearch| ?

    – solsTiCe
    Dec 18 '18 at 7:44













    0














    Try:



    yelp man:<command>


    For example:



    yelp man:cp





    share|improve this answer




























      0














      Try:



      yelp man:<command>


      For example:



      yelp man:cp





      share|improve this answer


























        0












        0








        0







        Try:



        yelp man:<command>


        For example:



        yelp man:cp





        share|improve this answer













        Try:



        yelp man:<command>


        For example:



        yelp man:cp






        share|improve this answer












        share|improve this answer



        share|improve this answer










        answered 4 hours ago









        Brad HornBrad Horn

        1012




        1012






























            draft saved

            draft discarded




















































            Thanks for contributing an answer to Ask Ubuntu!


            • Please be sure to answer the question. Provide details and share your research!

            But avoid



            • Asking for help, clarification, or responding to other answers.

            • Making statements based on opinion; back them up with references or personal experience.


            To learn more, see our tips on writing great answers.




            draft saved


            draft discarded














            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2faskubuntu.com%2fquestions%2f1058947%2fhow-to-run-full-text-search-on-help-pages-offline-from-yelp-gnome-help-or-som%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown





















































            Required, but never shown














            Required, but never shown












            Required, but never shown







            Required, but never shown

































            Required, but never shown














            Required, but never shown












            Required, but never shown







            Required, but never shown







            Popular posts from this blog

            GameSpot

            日野市

            Tu-95轟炸機