elementary / terminal

Terminal emulator designed for elementary OS
https://elementary.io
GNU Lesser General Public License v3.0
399 stars 96 forks source link

Update manpage #730

Closed jeremypw closed 1 year ago

jeremypw commented 1 year ago

Fixes #728

Appearance of revised man page can be seen by running groff -man -T ascii io.elementary.terminal.1 in the debian folder in a terminal

danirabbit commented 1 year ago

Is there a reason why the man page is in packaging instead of in the main source?

jeremypw commented 1 year ago

I am not sure of the technicalities but the source man page file seems to get compressed before getting put in usr\share\man\man1 . There may be other requirements for man to work properly? It seems simpler for deb to handle it. Is there an advantage in putting it in main source? The flatpaks I've tested do not seem to install man pages anyway.

danirabbit commented 1 year ago

No idea, I was just curious if this was a legacy thing and if it might effect, for example, distribution on Fedora for us to have this in packaging

tintou commented 1 year ago

It used to be more difficult (especially with cmake), but now meson supports it natively so we can bring it back to the main repo

jeremypw commented 1 year ago

Ah, I wasnt aware of the native meson support so using that makes sense to lessen deb specific stuff.

jeremypw commented 1 year ago

Just tried out the meson install_man function and it works as expected (not compressing the file) but if there is a compressed file already installed by deb present then that is shown by preference. Not sure what to do about that.

jmgibson1981 commented 1 year ago

if you used my patch I'm happy that I could contribute but I failed was half asleep. forgot to add the proper -- commands for the new options in the page. Posting fix for my first patch if needed, unless you caught it.


+++ new.io.elementary.terminal.1    2023-05-31 12:17:19.082819021 -0700
@@ -13,13 +13,13 @@
 .BR \-h ", " \-\-help
 Show help message and exit
 .TP
-.BR \-n ", " \-\-help
+.BR \-n ", " \-\-newwindow
 Forces a new window
 .TP
-.BR \-t ", " \-\-help
+.BR \-t ", " \-\-newtab
 Forces a new tab
 .TP
-.BR \-m ", " \-\-minimized
+.BR \-m ", " \-\-help
 Starts terminal in a minimized state
 .TP
 .BR \-v ", " \-\-version
eli-schwartz commented 1 year ago

Just tried out the meson install_man function and it works as expected (not compressing the file) but if there is a compressed file already installed by deb present then that is shown by preference. Not sure what to do about that.

If you installed the software with a deb, you should update it with a deb and that will update the compressed file installed by the deb.