Skip to content

Commit

Permalink
Add man page sources, for archival purposes
Browse files Browse the repository at this point in the history
  • Loading branch information
beandog committed Dec 4, 2023
1 parent 644d803 commit ef3d674
Show file tree
Hide file tree
Showing 3 changed files with 300 additions and 0 deletions.
87 changes: 87 additions & 0 deletions bluray_copy.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
BLURAY_COPY(1)
==============
:doctype: manpage

NAME
----
bluray_copy - copy a title or playlist from a Blu-ray to a file or stdout

SYNOPSIS
--------
*bluray_copy* ['PATH'] ['OPTIONS']

DESCRIPTION
-----------
The bluray_copy(1) program will copy a title or playlist from a Blu-ray disc,
image, or directory to either a file or stdout.

Input path can be a single filename (image), a directory, or a device name.
The default device is based on your operating system, and is the primary
optical drive.

Default output filename is 'bluray_title_###.m2ts' where the number is
a zero-padded string of the main title.

OPTIONS
-------

*-m, --main*::
Copy the main title (default).

*-t, --title*='TITLE'::
Copy the selected title number.

*-p, --playlist*='PLAYLIST'::
Copy the selected playlist.

*-c, --chapter*='CHAPTER[-CHAPTER]'
Copy the selected chapter or range range. Default is to copy all
chapters of the title or playlist.

*-o, --output*='FILENAME'
Save to filename. Default is 'bluray_title_###.m2ts'.

'FILENAME' can be '-' to send to standard output. All display output
is switched to standard error output.

*-k, --keydb*='FILENAME'
Location to 'KEYDB.cfg' used by libaacs for decryption. Default is
'~/.config/aacs/KEYDB.cfg'

*-a, --angle*='ANGLE'
Video angle number. Default is the first.

*-d, --duplicates*
Select from index of duplicate titles instead of only relevant

*-h, --help*
Display help output.

*--version*
Display version information.

SEE ALSO
--------
bluray_info(1), bluray_player(1)

BUGS
----
*bluray_copy* does not wait for an optical device to be ready. Wait for it to
finish "polling" before running the program.

Please file bugs at <https://github.com/beandog/bluray_info/issues>

AUTHOR
------
bluray_copy was written by Steve Dibb <[email protected]>

RESOURCES
---------
Source code available at GitHub: <https://github.com/beandog/bluray_info>

Main web site: <https://dvds.beandog.org>

COPYING
-------
Copyright \(C) 2019 Steve Dibb. Free use of this software is granted under the
terms of the GNU General Public License, version 2 (GPL).
109 changes: 109 additions & 0 deletions bluray_info.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
BLURAY_INFO(1)
==============
:doctype: manpage

NAME
----
bluray_info - displays information about a Blu-ray

SYNOPSIS
--------
*bluray_info* ['PATH'] ['OPTIONS']

DESCRIPTION
-----------
The bluray_info(1) program displays information about a Blu-ray disc, image,
or directory in human-readable, JSON, or formatted chapter outputs.

Input path can be a single filename (image), a directory, or a device name.
The default device is based on your operating system, and is the primary
optical drive.

OPTIONS
-------

*-m, --main*::
Display only the main title / playlist as defined by the metadata. By
default, bluray_info will display all titles.

*-t, --title*='TITLE'::
Limit output to the selected title.

*-p, --playlist*='PLAYLIST'::
Limit output to selected playlist.

*-k, --keydb*='FILE'::
Location to 'KEYDB.cfg' used by libaacs for decryption. Default is
'~/.config/aacs/KEYDB.cfg'.

*-v, --video*::
Display detailed information about video streams.

*-a, --audio*::
Display detailed information about audio streams.

*-s, --subtitles*::
Display detailed information about subtitles.

*-c, --chapters*::
Display detailed information about chapters.

*-x, --all*::
Display all optional detailed information.

*-d, --duplicates*::
Display duplicate titles that libbluray would originally filter out

*-j, --json*::
Format output in JSON. All detailed information is included.

*-A, --has-audio*::
Limit output to titles that have audio tracks.

*-S, --has-subtitles*::
Limit output to titles that have subtitles.

*-E, --seconds*='SECONDS'::
Limit output to titles with a minimum length of number of seconds.

*-M, --minutes*='MINUTES'::
Limit output to titles with a minimum length of number of minutes.
Cannot be used in combination with '--seconds'.

*-g, --xchap*::
Display title chapters in export format suitable for mkvmerge(1) and
ogmmerge(1). See also dvdxchap(1) for details on format syntax.

*-h, --help*::
Display help output.

*--version*::
Display version information.

SEE ALSO
--------
bluray_copy(1), bluray_player(1)

BUGS
----
*bluray_info* does not wait for an optical device to be ready. Wait for it to
finish "polling" before running the program.

Some discs fail to be opened if they have encryption that libaacs cannot read.

Please file bugs at <https://github.com/beandog/bluray_info/issues>

AUTHOR
------
bluray_info was written by Steve Dibb <[email protected]>

RESOURCES
---------
Source code available at GitHub: <https://github.com/beandog/bluray_info>

Main web site: <https://dvds.beandog.org>

COPYING
-------
Copyright \(C) 2019 Steve Dibb. Free use of this software is granted under the
terms of the GNU General Public License, version 2 (GPL).
104 changes: 104 additions & 0 deletions bluray_player.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
BLURAY_PLAYER(1)
================
:doctype: manpage

NAME
----
bluray_player - play a Blu-ray using libmpv

SYNOPSIS
--------
*bluray_player* ['PATH'] ['OPTIONS']

DESCRIPTION
-----------
The bluray_player(1) program will play a title or playlist from a Blu-ray
disc, image, or directory. Playback is enabled using libmpv.

Input path can be a single filename (image), a directory, or a device name.
The default device is based on your operating system, and is the primary
optical drive.

OPTIONS
-------

*-m, --main*::
Play the main title (default).

*-t, --title*='TITLE'::
Play the selected titled number.

*-p, --playlist*='PLAYLIST'::
Play the selected playlist number.

*-c, --chapters*='CHAPTER[-[CHAPTER]]'
Play the selected chapter range. Default is to play all chapters of
the title / playlist.

*-a, --alang*='LANGUAGE'
Set default audio language. Format is three-letter language code, ISO
639-2. For example: eng, deu, fra, spa.

*-A, --aid*='STREAM ID'
Play audio stream ID indexed by mpv.

*-s, --slang*='LANGUAGE'
Display subtitles for selected language, if available.

*-S, --sid*='STREAM ID'
Play subtitle stream ID indexed by mpv.

*-V, --vid*='STREAM ID'
Play video stream ID indexed by mpv (default: first).

*-f, --fullscreen*
Display video in fullscreen.

*-d, --deinterlace*
Deinterlace video during playback.

*-k, --keydb*='FILENAME'
Location to 'KEYDB.cfg' used by libaacs for decryption. Default is
'~/.config/aacs/KEYDB.cfg'

*-h, --help*
Display help output.

*--version*
Display version information.

CONFIGURATION
-------------
bluray_player(1) uses libmpv as the engine for playback (see
<https://mpv.io/>). Configuration for bluray_player is stored in
~/.config/bluray_player/mpv.conf and will be read on each time during startup.

Passing options to 'bluray_player' will override the configuration file.

See mpv(1) for all configuration options.

SEE ALSO
--------
bluray_info(1), bluray_copy(1), mpv(1)

BUGS
----
*bluray_player* does not wait for an optical device to be ready. Wait for it to
finish "polling" before running the program.

Please file bugs at <https://github.com/beandog/bluray_info/issues>

AUTHOR
------
bluray_player was written by Steve Dibb <[email protected]>

RESOURCES
---------
Source code available at GitHub: <https://github.com/beandog/bluray_info>

Main web site: <https://dvds.beandog.org>

COPYING
-------
Copyright \(C) 2019 Steve Dibb. Free use of this software is granted under the
terms of the GNU General Public License, version 2 (GPL).

0 comments on commit ef3d674

Please sign in to comment.