Re: online manual for packaged version?

[email protected] writes:

> I install unison using brew on OS X (doing a brew install
> homebrew/cask/unison), and I do not have access to the manual:
>
> schmitta@TM ~ % brew list -v unison           
> /opt/homebrew/Caskroom/unison/.metadata/config.json
> /opt/homebrew/Caskroom/unison/.metadata/2.53.3/20230609153419.602/Casks/unison.rb
> /opt/homebrew/Caskroom/unison/2.53.3/Unison.app
> schmitta@TM ~ % brew list unison              
> ==> App
> /Applications/Unison.app (48 files, 4.7MB)
> ==> Binary
> /opt/homebrew/bin/unison -> /Applications/Unison.app/Contents/MacOS/cltool (51.5KB)
> ==> Postflight Block
> postflight (Postflight Block)

brew not building and installing the manual and the man page is a
problem in brew and should be reported to them.  As an example, pkgsrc
installs the man page, but currently not the manual:

  $ pkg_info -L unison
  Information for unison-2.53.3.0.50:

  Files:
  /usr/pkg/bin/unison
  /usr/pkg/man/man1/unison.1
  /usr/pkg/share/doc/unison/COPYING
  /usr/pkg/share/doc/unison/CONTRIBUTING.md
  /usr/pkg/share/doc/unison/INSTALL.md
  /usr/pkg/share/doc/unison/NEWS.md

(brew should also install COPYING, most likely)

> In the application, I can go to the Help menu to get to the Unison
> Online Help, and the web page linked is
> https://www.cis.upenn.edu/~bcpierce/unison/docs.html which is out of
> date.

Pointing to that is a bug -- thanks for reporting.  That reference
should be updated, and the one in unison.1.in should be dropped.

  https://urldefense.com/v3/__https://github.com/bcpierce00/unison/issues/936__;!!IBzWLUs!QuZRPabJm05-A4jVH5d7BrDogpGzITruZpYHITC91SLdca3YiuSw2eGiXTLqx2Y38p3NFJxV8kxe6EYt_w$ 

I have reported to bcpierce that the docs.html page should be rm'd.

> Is there an up-to-date version of the manual online, and could the OS X
> application be updated to link to it?

In general, I think installed programs should also install
documentation, as there is no reason to expect the user to be Internet
connected -- unison should work just fine among computers connected to
each other but without global connectivity.

That said, the CI artifacts do include the manual (in each build),
although there is not a CI artifact with just the manual.

  https://urldefense.com/v3/__https://github.com/bcpierce00/unison/wiki/Downloading-Unison__;!!IBzWLUs!QuZRPabJm05-A4jVH5d7BrDogpGzITruZpYHITC91SLdca3YiuSw2eGiXTLqx2Y38p3NFJxV8kzT2Z1Mug$ 
  https://urldefense.com/v3/__https://github.com/bcpierce00/unison/issues/819__;!!IBzWLUs!QuZRPabJm05-A4jVH5d7BrDogpGzITruZpYHITC91SLdca3YiuSw2eGiXTLqx2Y38p3NFJxV8kyGI354jQ$ 

There is, for now, a 'documentation' branch in the git repo which has
built documentation, and it is currently up to date with the latest
release.  I just added a pointer to the top-level wiki page.  I would
like to remove this once there is a documentation release artifact.

  https://urldefense.com/v3/__https://github.com/bcpierce00/unison/tree/documentation__;!!IBzWLUs!QuZRPabJm05-A4jVH5d7BrDogpGzITruZpYHITC91SLdca3YiuSw2eGiXTLqx2Y38p3NFJxV8kzkE5p8DQ$ 

You can also check out the sources, read INSTALL.md, and "gmake docs".
You'll need latex for pdf and hevea for the html version.

Or, you can run "unison -doc topics" as suggested by `unison --help`;
there is a text version inside the unison binary.

-- 
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].