mirror of
https://github.com/SinTan1729/movie-rename.git
synced 2024-10-16 16:53:53 -05:00
40 lines
1.4 KiB
Groff
40 lines
1.4 KiB
Groff
.\" Manpage for movie-rename.
|
|
.\" Contact sayantan[dot]santra689[at]gmail[dot]com to correct errors or typos.
|
|
.TH man 1 "February 2023" "movie-rename"
|
|
.SH NAME
|
|
movie-rename
|
|
.SH SYNOPSIS
|
|
movie-rename <filename(s)> [-n|--dry-run] [-d|--directory] [-h|--help] [-v|--version]
|
|
.SH DESCRIPTION
|
|
movie-rename is a simple tool to rename movies, written in Rust.
|
|
.SH ARGUMENTS
|
|
A list of filenames (or directory names, not both). -d or --directory must be passed to work with directories.
|
|
.SH OPTIONS
|
|
.TP
|
|
-n, --dry-run
|
|
Performs a dry run, without actually renaming anything.
|
|
.TP
|
|
-d, --directory
|
|
Runs in directory mode. In this mode, it is assumed that the arguments are directory names, which contain exactly one movie and optionally subtitles.
|
|
.TP
|
|
-dn, -nd
|
|
Performs a dry run in directory mode.
|
|
.TP
|
|
-h, --help
|
|
Print help information.
|
|
.TP
|
|
-v, --version
|
|
Print version information.
|
|
.SH CONFIG
|
|
There needs to be a config file named config in the $XDG_CONFIG_HOME/movie-rename/ directory.
|
|
It should consist of two lines.
|
|
.sp
|
|
The first line should have your TMDb API key.
|
|
.sp
|
|
The second line should have a pattern, that will be used for the rename.
|
|
.sp
|
|
In the pattern, the variables need to be enclosed in {}, the supported variables are `title`, `year` and `director`.
|
|
.sp
|
|
Default pattern is `{title} ({year}) - {director}`. Extension is always kept.
|
|
.SH AUTHOR
|
|
Sayantan Santra sayantan[dot]santra689[at]gmail[dot]com
|