After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 605249 - Manpage for GNOME Shell
Manpage for GNOME Shell
Status: RESOLVED FIXED
Product: gnome-shell
Classification: Core
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gnome-shell-maint
gnome-shell-maint
Depends on:
Blocks:
 
 
Reported: 2009-12-22 20:14 UTC by Gustavo Noronha (kov)
Modified: 2010-02-09 23:20 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
manpage (2.81 KB, application/octet-stream)
2009-12-22 20:14 UTC, Gustavo Noronha (kov)
  Details
manpage (3.85 KB, patch)
2010-02-07 03:37 UTC, Marcelo Jorge Vieira
none Details | Review

Description Gustavo Noronha (kov) 2009-12-22 20:14:06 UTC
Created attachment 150251 [details]
manpage

The attached file has been sent to the Debian BTS, contributed by Marcelo Vieira, please consider its inclusion =).
Comment 1 Owen Taylor 2010-02-05 22:41:47 UTC
This looks like a good start on a man page. It needs a little updating, and I think I'd probably replace the introductory paragraph taken from live.gnome.org with the description I've used for the Fedora RPMS:

 GNOME Shell provides core user interface functions for the GNOME 3 desktop,
 like switching to windows and launching applications. GNOME Shell takes
 advantage of the capabilities of modern graphics hardware and introduces
 innovative user interface concepts to provide a visually attractive and
 easy to use experience.

My only question for the contributor (if you could pass this back to them I'd appreciate it), is if they would mind if I removed the text "This manpage was written by Marcelo Jorge Vieira (metal) <metal@alucinados.com>" from the man page itself - I'm sure that the man page will need various updates over time, and I'm not sure credit or blame for some future version should be assigned to a single person. I'd leave the copyright notice in the source file, and Marcelo would get credit in the GIT history of course!
Comment 2 Marcelo Jorge Vieira 2010-02-07 03:37:52 UTC
Created attachment 153182 [details] [review]
manpage

hi Owen,
attach you will find a git patch with your suggestions.

Cheers,
Comment 3 Owen Taylor 2010-02-09 23:20:22 UTC
Many thanks!

Committed with the following minor changes:

 - Lined wrapped the very long lines
 - Added a better description for --sync
 - Resorted the command line options to group them roughly
   by function.