Bug 1334025

Summary: Firefox man page and `--help` text have out-of-date commandline options
Product: [Fedora] Fedora Reporter: Audrey Yeena Toskin <audrey>
Component: firefoxAssignee: Martin Stransky <stransky>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 37CC: audrey, bcotton, gecko-bugs-nobody, jhorak, pjasicek, stransky, t-fedora, zbyszek
Target Milestone: ---Keywords: Reopened
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-10-02 06:17:54 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
proposed man page for firefox-dev
none
Proposed man page for Firefox (info from `firefox --help`)
none
updated man page for firefox(1)
none
man page updated 2019 none

Description Audrey Yeena Toskin 2016-05-07 09:19:49 UTC
I've only checked these in Fedora 23, but since the man page has not been updated in a long time, these issues are probably true for older and newer Fedora packages as well.

The commandline options described in the Firefox man page are out-of-date. Particularly:

`-remote` was removed in Firefox 39.0. See <https://developer.mozilla.org/en-US/docs/Mozilla/Command_Line_Options#-remote_remote_command>

`-private-toggle` is no longer available... I think. I can't find anything that explicitly states that it was removed, but it's no longer listed on the Command Line Options page linked above, nor in the `--help` text, and doesn't seem to do anything.

`--no-xshm` and `--xim-preedit` X11-specific Firefox options are no longer listed on the Mozilla wiki page linked above. Perhaps they have been removed from Firefox as well?

`-devtools` is missing from the man page and the the Mozilla Command Line Options page linked above, but still appears in the `--help` text, and does still work. (It opens the developer tools panel when Firefox launches.)

The `--help` text also lists options `--recording` and `--recording-output`, but these do not appear in the man page, nor are they documented on the Mozilla wiki page.

Comment 1 Audrey Yeena Toskin 2016-05-08 04:02:26 UTC
I noticed this issue while editing the man page to suit a package I'm working on for Firefox Developer Edition. So after you weigh in with your thoughts about the issues here, I could send a patch that updates the man page.

Comment 2 Fedora End Of Life 2016-11-25 08:58:14 UTC
This message is a reminder that Fedora 23 is nearing its end of life.
Approximately 4 (four) weeks from now Fedora will stop maintaining
and issuing updates for Fedora 23. It is Fedora's policy to close all
bug reports from releases that are no longer maintained. At that time
this bug will be closed as EOL if it remains open with a Fedora  'version'
of '23'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version' 
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora 23 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora, you are encouraged  change the 'version' to a later Fedora 
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's 
lifetime, sometimes those efforts are overtaken by events. Often a 
more recent Fedora release includes newer upstream software that fixes 
bugs or makes them obsolete.

Comment 3 Zbigniew Jędrzejewski-Szmek 2016-11-30 17:32:58 UTC
man firefox still shows -remote in F26.

Comment 4 Audrey Yeena Toskin 2016-12-19 02:02:16 UTC
> `-private-toggle` is no longer available... and doesn't seem to do anything.

Correction: For unsupported command line options like this, Firefox falls back to opening a new (normal) window. So `firefox -private-toggle` doesn't do nothing, but it doesn't toggle private browsing mode either.

Comment 5 Fedora End Of Life 2017-02-28 09:58:09 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 26 development cycle.
Changing version to '26'.

Comment 6 Tobi 2017-11-28 18:53:38 UTC
I can confirm this bug; on Fedora 26 the manpage advertises a date of August 07, 2001 (!)

The man page mentiones the -private flag, which has been replaced by --private-window quite some time ago and to make matters worse, -private actually _breaks the private mode_ until firefox gets restarted. 

The report on Mozilla's bugtracker has been dismissed, because the man page is apparently distro-provided. (https://bugzilla.mozilla.org/show_bug.cgi?id=1381866)

Comment 7 Martin Stransky 2017-11-29 07:46:28 UTC
Thanks for your report, do you mind to provide an updated man page we can ship?

Comment 8 Audrey Yeena Toskin 2017-11-29 23:58:56 UTC
Created attachment 1360621 [details]
proposed man page for firefox-dev

I haven't looked at this or worked on my Firefox Developer Edition package in a while, so you might want to double check this. But here's the man page I have, which at least incorporates the changes I mentioned in my original post. Note this man page also changed the package and binary names to suit the RPM I was experimenting with, so you would at least want to change those back to plain "firefox".

Comment 9 Tobi 2017-11-30 15:02:38 UTC
Andrew, your man page is also not up-to-date. I'm working on merging the information from `firefox --help` in at the moment.

Comment 10 Tobi 2017-11-30 15:30:00 UTC
Created attachment 1360974 [details]
Proposed man page for Firefox (info from `firefox --help`)

Done. Any feedback appreciated!

Comment 11 Martin Stransky 2017-12-04 07:55:44 UTC
Thanks, we'll add it to next release.

Comment 12 Tobi 2017-12-04 11:07:47 UTC
Created attachment 1362629 [details]
updated man page for firefox(1)

just noticed that the "see also" section mentiones a man page that does not exist. removed it. 

stoked to see this happen; firefox really deserves an up-to-date manual

Comment 13 Martin Stransky 2017-12-04 11:36:18 UTC
Added to firefox-57.0.1-2, Thanks!

Comment 14 Tobi 2019-07-10 16:49:41 UTC
Created attachment 1589159 [details]
man page updated 2019

Comment 15 Tobi 2019-07-10 16:52:37 UTC
I've updated the manual since there were some changes in the last 1½ years. It appears I can't reopen the bug, so I've needinfo'd -- apologies if that's rude.

Comment 16 Audrey Yeena Toskin 2019-07-13 04:19:35 UTC
I would say it would have been better to just submit a new ticket than reopen one a similar one that was solved a year and a half ago... Or, if you have a Fedora account, you could submit a pull request to https://src.fedoraproject.org/rpms/firefox

But since you're here already, I guess I can reopen it for you.

The updated manpage looks reasonable to me. Nothing radical, so it should be an easy merge :)

Comment 17 Ben Cotton 2022-08-09 13:37:25 UTC
This bug appears to have been reported against 'rawhide' during the Fedora Linux 37 development cycle.
Changing version to 37.

Comment 18 Martin Stransky 2023-10-02 06:17:39 UTC
(In reply to Tobias from comment #14)
> Created attachment 1589159 [details]
> man page updated 2019

Added to Firefox/Fedora, Thanks.