1444737 - Review content of SeaMonkey Man page

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, enhancement)

Description

[Frank-Rainer Grahl (:frg)]

+++ This bug was initially created as a clone of Bug #1089324 +++

Bug 1089324 added the man page to the Linux package and updated some obsolete content.

Per Bug 1089324 comment 7 the remaining content should be checked and maybe also localized.

> is there another bug for making sure the man page content is up to date?

Comment 1

[Dmitry Butskoy (:buc)]

Attachment: seamonkey.man.in-v2020

New seamonkey(1) manual for Linux/Unix systems.

Some old options removed, some missing added. Drop extra things as well.

Something is omitted:

• Present in the source code, but still not included in manual (either seems extra, or just cannot find proper info):

  • dump-args
  • test-launch-without-hang
  • test-process-updates
  • appomni
  • greomni
  • file
  • osint
  • override
  • reset-profile

• Present in "-help" output, but cannot find in the code:

  • UILocale

• Not documented for now:

  • setDefaultBrowser
  • setDefaultFeed
  • setDefaultMail
  • setDefaultNews
  • chat
  • inspector

• Present in "-help" output, but seems not working:

  • devtools
  • jsdebugger
  • recording
  • recording-output
  • start-debugger-server
  • wait-for-jsdebugger

• Present in the source code, but seems not working:

  • width
  • height

It could be fine if anybody else will look into the new man page (esp. native English).

Comment 2

[Frank-Rainer Grahl (:frg)]

Comment on attachment 9168048 [details]
seamonkey.man.in-v2020

Not that familiar with Linux

Comment 3

[Dmitry Butskoy (:buc)]

If due to lack of man power it seems unlikely that anyone else with enough Linux/UNIX experience will look at this man page, then just apply it as it is...

Comment 4

[Nuno Silva [:njsg]]

If I'm understanding it correctly, --UILocale was removed in bug 1347306.

Comment 5

[Dmitry Butskoy (:buc)]

Yep, thanks.

Comment 6

[Nuno Silva [:njsg]]

Looking at the code for -news[1] and -mail[2], it seems that both will open Mail&News, with the difference that -mail will raise an existing Mail&News window, if one already exists. -news always opens a new window. Neither seems to "select" the corresponding portion (-news does not select newsgroups and -mail may raise an existing window that has a newsgroup selected).

I couldn't find the code that handles "-news news_url". "-mail url" might be able to handle news messages, but so far I haven't been able to use it - I'm probably doing something wrong.

[1] mailnews/news/src/nsNntpService.cpp
[2] mailnews/base/src/nsMailNewsCommandLineHandler.js

Comment 7

[Nuno Silva [:njsg]]

If firefox is mentioned under "See also", should thunderbird be mentioned as well?

Comment 8

[Dmitry Butskoy (:buc)]

Attachment: seamonkey.man.in-v2020-v2

Thanks.

Drop unused "-news url", combine "-mail" and "-news" together and mention thunderbird in "see also".

Comment 9

[Nuno Silva [:njsg]]

• In the first -CreateProfile, is the "Do not run ..." part about it opening a new window instead if SeaMonkey is already open? If so, would this sound better?:
  «If @MOZ_APP_DISPLAYNAME@ is already open, \fB-CreateProfile\fR will not work unless the \fB-no-remote\fR option is used to avoid connecting to a running instance.»

• In the second -CreateProfile, there are two spaces between profile_name and profile_dir, I suppose this should be one space?

• Should "-private" say it opens a «"private browsing" window» or a «private browser window» instead of just «private window»? (Or is there some situation where it opens something other than a browser window?)

Comment 10

[Nuno Silva [:njsg]]

The -offline option seems to require offline.startup_state to be set to 4, see the table entry at [1] (which lists bug 382302 as the reference). If this is exactly how it works, the manpage could say

«This option will only work if @MOZ_APP_DISPLAYNAME@ is set to "detect automatically" the online/offline status on startup. To set this, go to Edit -> Preferences -> Mail & Newsgroups -> Network & Storage and in the "Offline" group choose "Detect automatically (if available)" in the "When starting up:" drop-down box.»

(Unless it is desirable to leave it out of the manpage?)

[1] http://kb.mozillazine.org/Mail_and_news_settings

Comment 11

[Nuno Silva [:njsg]]

And so far I haven't been able to use the -migration option here. It's possible that it needs something which is not present on this computer (other programs to import from?).

Comment 12

[Dmitry Butskoy (:buc)]

(In reply to Nuno Silva from comment #9)

• In the first -CreateProfile, is the "Do not run ..."

I just follow the description at https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options . As is. Probably we should not alter it...

• In the second -CreateProfile, there are two spaces between profile_name and profile_dir, I suppose this should be one space?

Yes!

• Should "-private" say it opens a «"private browsing" window» or a «private browser window» instead of just «private window»? (Or is there some situation where it opens something other than a browser window?)

Private browser window only.

(In reply to Nuno Silva from comment #10)

The -offline option
(Unless it is desirable to leave it out of the manpage?)

Let's just preserve it in the same form as in https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options .

(In reply to Nuno Silva from comment #11)

And so far I haven't been able to use the -migration option here.

Seems not working, and seems it is unlikely SM will support of some kind of migration... Better drop it from the manpage.

Hint me when to upload a new attachment...

Comment 13

[Nuno Silva [:njsg]]

Turns out I didn't test -migration properly. With something that looks like a Thunderbird profile directory, with a profile and profiles.ini, -migration will indeed work. So perhaps it should have a note saying that it will only open the import wizard if it finds sources to import from?

Comment 14

[Dmitry Butskoy (:buc)]

Yes. Maybe:

Start with import wizard (if you have proper import sources).

Comment 15

[Nuno Silva [:njsg]]

(In reply to Dmitry Butskoy from comment #12)

Hint me when to upload a new attachment...

I think I don't have more feedback for the current version of the attachment, so if you want you could upload a new version.

Comment 16

[Dmitry Butskoy (:buc)]

Attachment: seamonkey.man.in-v2020-v3

patch v3.

Comment 17

[Dmitry Butskoy (:buc)]

We seem to have done our best with it for the moment. Let put this in (ie. suite/app/seamonkey.man.in)

Comment 18

[Frank-Rainer Grahl (:frg)]

Comment on attachment 9171584 [details]
seamonkey.man.in-v2020-v3

Nuno can this go in? You looked at it I think.

Comment 19

[Nuno Silva [:njsg]]

The only thing I'm not sure about is the description for -offline; the rest looks OK to me.

Comment 20

[Dmitry Butskoy (:buc)]

(In reply to Nuno Silva from comment #10)

The -offline option
(Unless it is desirable to leave it out of the manpage?)

Let's just preserve it in the same form as in https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options .

Either leave it as is, or feel free to remove it completely (looks like some rare thing anyway).

Comment 21

[Nuno Silva [:njsg]]

Attachment: seamonkey.man.in-v2020-v4

Comment 22

[Nuno Silva [:njsg]]

(In reply to Dmitry Butskoy from comment #20)

Either leave it as is, or feel free to remove it completely (looks like some rare thing anyway).

I'd say we either remove -offline from the man page or explain how to make it work.

I have no idea how many people use (or will use) it, but it looks like the kind of option that could be included in the man page. And given that the UI for this option is under "Mail & Newsgroups", it is probably a good idea to indicate in which preferences panel it is.

(-v4 is -v3 plus that additional note for -offline)

Comment 23

[Dmitry Butskoy (:buc)]

Latest -v4 is OK.

Comment 24

[Frank-Rainer Grahl (:frg)]

Attachment: 1444737-suiteman-2535.patch

Latest version as a patch for checkin. r/a+ from me. Thanks.

Comment 25

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/8b8b28239a86
Update SeaMonkey man page content. r=frg

Comment 26

[Frank-Rainer Grahl (:frg)]

https://gitlab.com/seamonkey-project/seamonkey-2.53-comm/-/commit/a76cab5545ad651a5453291e8f12cc612c5401cc

Comment 27

[Dmitry Butskoy (:buc)]

Attachment: seamonkey-2.53.6-install_man.patch

Since we provide the UNIX man page, it should be properly installed rather then staying somewhere in the build objdir.

Proposed patch perform the work, while respecting downstreams' desire to vary mandir.

Note, that `--mandir' is actually supported by old-configure, but was missed in build/moz.configure/old.configure .

Firefox does not provide its UNIX man page, and this is unlikely in the future. Probably that they decided to move the maintainance of it from the upstream to "Linux downstream", assuming that there should be only one downstream (as with Win and Mac). They don't care the fact many systems should maintain the same little file -- it is a problem of those systems rather than FF itself.

Contrasting with it, let's provide SM man page most correct way.

Comment 28

[Ian Neal]

Comment on attachment 9198784 [details] [diff] [review]
seamonkey-2.53.6-install_man.patch

I don't see an issue with this as such but please do not reopen old bugs. Open a new one on SM Build Config and attach a patch in either git or hg diff format.