Update man page

Bug #1159150 reported by jus
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mixxx
Fix Released
Low
jus
mixxx (Ubuntu)
Fix Released
Undecided
Unassigned

Bug Description

We provide only a rudimentary man page for linux, see "man mixxx" or http://manpages.ubuntu.com/manpages/precise/en/man1/mixxx.1.html .

Generally i found man pages pretty useful. Not sure how many users make use of man pages, but it wont hurt.

The attached patch updates build/debian/mixxx.sgml which is completely revised for 1.11

To test the update invoke following commands:
docbook-to-man mixxx.sgml > mixxx.1
gzip mixxx.1 > mixxx.1.gz
sudo cp mixxx.1.gz /usr/share/man/man1
man mixxx

Alternatively, you can type "man:/usr/share/man/man1/mixxx.1.gz" to view in Konqueror

Tags: patch docs

Related branches

Revision history for this message
jus (jus) wrote :
Revision history for this message
Max Linke (max-linke) wrote :

should we write that mixxx support m4a? I thought by default this feature is disabled and users have to compile mixxx themselves to enable it. If so I'm happy with a hint to that.

I've added some text about ~/.mixxx/analysis and ~/.mixxx/controllers.

Revision history for this message
jus (jus) wrote :

Thanks for the additions Max.
Can't say much about the actual state of m4a support on Linux, someone who knows please chime in.

Revision history for this message
Max Linke (max-linke) wrote :

m4a/aac is not enabled by deafult on linux. I removed it as supported but added a link with hints on how to enable it.

I also changed the note about licensing to GPL-2 which mixxx is using right now

Revision history for this message
jus (jus) wrote :

I played a bit with the wording and added your name to the credits in the history. Your may want to add your mail adress there before committing, the man page looks fine to me now.

Revision history for this message
RJ Skerry-Ryan (rryan) wrote : Re: [Bug 1159150] Re: Update man page

Some minor changes:

For the ~/.mixxx/analysis description:

+ The directory where &dhpackage; stores any additional analysis data
+ that can't fit into the library file. Currently only the waveforms
+ are saved here. If you delete your library file you
should also delete
+ this folder as the waveforms are around 1MB each and are
unusable without
+ the library that generated them.

In the ~/.mixxx/contollers description, "midi" should be capitalized.

In AUTHORS, led vs. lead and cleaned up the first sentence.

+ <para>Since 2000, over 150 developers, artists and translators have
+ helped create &dhpackage;. The current &dhpackage; development team is
+ led by RJ Ryan <email><email address hidden></email>.
+ </para>

On Fri, Apr 12, 2013 at 3:58 AM, jus <email address hidden> wrote:

> I played a bit with the wording and added your name to the credits in
> the history. Your may want to add your mail adress there before
> committing, the man page looks fine to me now.
>
> ** Patch added: "man_v4.patch"
>
> https://bugs.launchpad.net/mixxx/+bug/1159150/+attachment/3641934/+files/man_v4.patch
>
> --
> You received this bug notification because you are a member of Mixxx
> Development Team, which is subscribed to Mixxx.
> https://bugs.launchpad.net/bugs/1159150
>
> Title:
> Update man page
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/mixxx/+bug/1159150/+subscriptions
>

Revision history for this message
jus (jus) wrote :

Thanks for reviewing, latest changes commited to lp:mixxx/1.11 r3815

Changed in mixxx:
status: In Progress → Fix Committed
RJ Skerry-Ryan (rryan)
Changed in mixxx:
status: Fix Committed → Fix Released
status: Fix Released → Fix Committed
Revision history for this message
RJ Skerry-Ryan (rryan) wrote :

I believe Alessio has to take care of this for us. I've notified him via email.

Revision history for this message
Ubuntu Foundations Team Bug Bot (crichton) wrote :

The attachment "man.patch" seems to be a patch. If it isn't, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are a member of the ~ubuntu-reviewers, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issues please contact him.]

tags: added: patch
Changed in mixxx (Ubuntu):
status: New → Fix Released
RJ Skerry-Ryan (rryan)
Changed in mixxx:
status: Fix Committed → Fix Released
Revision history for this message
Swiftb0y (swiftb0y) wrote :

Mixxx now uses GitHub for bug tracking. This bug has been migrated to:
https://github.com/mixxxdj/mixxx/issues/6956

lock status: Metadata changes locked and limited to project staff
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.