[MacPorts] #72252: VLC port seems to be missing documentation

[MacPorts]

#72252: VLC port seems to be missing documentation
---------------------------+--------------------
  Reporter:  seamusdemora  |      Owner:  (none)
      Type:  defect        |     Status:  new
  Priority:  Normal        |  Milestone:
 Component:  ports         |    Version:
Resolution:                |   Keywords:
      Port:  VLC           |
---------------------------+--------------------
Description changed by seamusdemora:

Old description:

> I installed VLC earlier. I couldn't find much information on this
> package, but I had hoped that the package would provide the "command
> line" version of VLC. I already had a GUI version of VLC installed on my
> Mac - I think I got this from the VLC website (??)
>
> The installation reported a successful install:
>
> {{{
> % sudo port install VLC
> --->  Fetching archive for VLC
> --->  Attempting to fetch VLC-3.0.11.1_0.darwin_22.x86_64.tbz2 from
> https://packages.macports.org/VLC
> --->  Attempting to fetch VLC-3.0.11.1_0.darwin_22.x86_64.tbz2.rmd160
> from https://packages.macports.org/VLC
> --->  Installing VLC @3.0.11.1_0
> --->  Activating VLC @3.0.11.1_0
> --->  Cleaning VLC
> --->  Updating database of binaries
> --->  Scanning binaries for linking errors
> --->  No broken files found.
> --->  No broken ports found.
> --->  Some of the ports you installed have notes:
>   VLC has the following notes:
>     MIDI support requires installing one or more SoundFont files, in
> /opt/local/share/sounds/sf2, for instance from port:generaluser-
> soundfont.
> }}}
>

> I checked for "info", but didn't learn anything about using the port.
>
> {{{
> % port info VLC
> VLC @3.0.11.1 (multimedia, devel)
> Sub-ports:            libVLC
>
> Description:          VLC media player is a highly portable multimedia
> player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX,
> mp3, ogg, ...) as well
>                       as DVDs, VCDs, and various streaming protocols. It
> can also be used as a server to stream in unicast or multicast in IPv4 or
> IPv6 on a
>                       high-bandwidth network.
> Homepage:             https://www.videolan.org
>
> Conflicts with:       libVLC
> Platforms:            darwin
> License:              GPL-2
> Maintainers:          Email: rjvbertin at gmail.com, GitHub: RJVB
>                       Policy: openmaintainer
> }}}
>
> I finally found the port under '/opt/local/bin/vlc3' using 'find'. I'm
> submitting this ticket to suggest that the filename be added to the
> 'info' output.

New description:

 There are two (2) issues in this ticket:

 ISSUE # 1:
 I installed VLC earlier. I couldn't find much information on this package,
 but I had hoped that the package would provide the "command line" version
 of VLC. I already had a GUI version of VLC installed on my Mac - I think I
 got this from the VLC website (??)

 The installation reported a successful install:

 {{{
 % sudo port install VLC
 --->  Fetching archive for VLC
 --->  Attempting to fetch VLC-3.0.11.1_0.darwin_22.x86_64.tbz2 from
 https://packages.macports.org/VLC
 --->  Attempting to fetch VLC-3.0.11.1_0.darwin_22.x86_64.tbz2.rmd160 from
 https://packages.macports.org/VLC
 --->  Installing VLC @3.0.11.1_0
 --->  Activating VLC @3.0.11.1_0
 --->  Cleaning VLC
 --->  Updating database of binaries
 --->  Scanning binaries for linking errors
 --->  No broken files found.
 --->  No broken ports found.
 --->  Some of the ports you installed have notes:
   VLC has the following notes:
     MIDI support requires installing one or more SoundFont files, in
 /opt/local/share/sounds/sf2, for instance from port:generaluser-soundfont.
 }}}


 I checked for "info", but didn't learn anything about using the port.

 {{{
 % port info VLC
 VLC @3.0.11.1 (multimedia, devel)
 Sub-ports:            libVLC

 Description:          VLC media player is a highly portable multimedia
 player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX,
 mp3, ogg, ...) as well
                       as DVDs, VCDs, and various streaming protocols. It
 can also be used as a server to stream in unicast or multicast in IPv4 or
 IPv6 on a
                       high-bandwidth network.
 Homepage:             https://www.videolan.org

 Conflicts with:       libVLC
 Platforms:            darwin
 License:              GPL-2
 Maintainers:          Email: rjvbertin at gmail.com, GitHub: RJVB
                       Policy: openmaintainer
 }}}

 I finally found the port under '/opt/local/bin/vlc3' using 'find'. I'm
 submitting this ticket to suggest that the filename be added to the 'info'
 output.


 ISSUE # 2:

 I wanted to run vlc **without** the GUI. However:

 {{{
 ==> vlc3 '/Users/seamus/Music/yt-dlp-sourced/Bury Me Not on the Lone
 Prairie ~ Bruce Molsky (2006) [Zr0ynSuRP98].m4a'
 VLC media player 3.0.11.1 Vetinari (revision 3.0.11.1-0-g52483f3ca2)

 ****************************
 [00007fe9dcf05fc0] main libvlc: Running vlc with the default interface.
 Use 'cvlc' to use vlc without interface.
 ****************************

 [00007fe9dcf080a0] main playlist: playlist is empty

 ****************************
 ==> cvlc3 '/Users/jmoore/Music/yt-dlp-sourced/Bury Me Not on the Lone
 Prairie ~ Bruce Molsky (2006) [Zr0ynSuRP98].m4a'
 zsh: command not found: cvlc3
 ****************************
 }}}

 So, how can I run vlc3 without the GUI???

--

-- 
Ticket URL: <https://trac.macports.org/ticket/72252#comment:1>
MacPorts <https://www.macports.org/>
Ports system for macOS