Skip to content

Commit ea2300a

Browse files
committed
- [*] update doc and add manpage
1 parent d84eab9 commit ea2300a

File tree

4 files changed

+58
-1
lines changed

4 files changed

+58
-1
lines changed

README.e.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ Please check them out in the [wiki](https://github.com/suntong/ffcvt/wiki/).
4444

4545
## Download/Install
4646

47+
### Using `apt`
48+
49+
The `ffcvt` is now officially in Debian repository, so the installation is now as simple as a `apt install`/`apt-get install`:
50+
51+
apt install ffcvt
52+
4753
### Download binaries
4854

4955
- The latest binary executables are available under

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [Environment Variables](#environment-variables)
1515
- [Encoding Help](#encoding-help)
1616
- [Download/Install](#downloadinstall)
17+
- [Using `apt`](#using-`apt`)
1718
- [Download binaries](#download-binaries)
1819
- [Debian package](#debian-package)
1920
- [Install Source](#install-source)
@@ -75,6 +76,7 @@ Flags:
7576
-force overwrite any existing none-empty file (FFCVT_FORCE)
7677
-debug debugging level (FFCVT_DEBUG)
7778
-ffmpeg ffmpeg program executable name (FFCVT_FFMPEG)
79+
-version print version then exit (FFCVT_VERSION)
7880

7981
Details:
8082

@@ -123,6 +125,8 @@ Details:
123125
copy video codec
124126
-vea string
125127
video encoding method append
128+
-version
129+
print version then exit
126130
-ves string
127131
video encoding method set
128132
-vn
@@ -156,6 +160,12 @@ Please check them out in the [wiki](https://github.com/suntong/ffcvt/wiki/).
156160

157161
## Download/Install
158162

163+
### Using `apt`
164+
165+
The `ffcvt` is now officially in Debian repository, so the installation is now as simple as a `apt install`/`apt-get install`:
166+
167+
apt install ffcvt
168+
159169
### Download binaries
160170

161171
- The latest binary executables are available under

ffcvt.1.ronn

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# ffcvt -- ffmpeg convert wrapper tool
2+
3+
## SYNOPSIS
4+
5+
ffcvt [flags] [video_filename]
6+
7+
8+
## OPTIONS
9+
10+
For `flags`, run `ffcvt` without parameters to see the comprehensive list and explanation.
11+
12+
13+
## DESCRIPTION
14+
15+
Command `ffcvt` is an easy to use video converter that takes the burden of such daunting task from normal Joe, to harness the fantastic high efficiency audio/video codec/encoding capability long been available in `ffmpeg`, by simplifying the convoluted `ffmpeg` command line parameters.
16+
17+
To encode a video, all you need to do is to give one parameter to `ffcvt`, i.e., the path and file name of the video to be encoded, and `ffcvt` will take care of the rest, using the recommended values for both audio/video encoding to properly encode it for you.
18+
19+
It can't be more simpler than that. However, beneath the simple surface, `ffcvt` is versatile and powerful enough to allow you to touch every corner of audio/video encoding. There is a huge list of environment variables (or command-line parameters) which will allow you tweak the encoding methods and parameters to exactly what you prefer instead.
20+
21+
Moreover, to encode a directory full of video files, including under its sub-directories, you need just to give `ffcvt` one single parameter, the directory location, and `ffcvt` will go ahead and encode all video files under that directory, including all its sub-directories as well.
22+
23+
24+
## EXAMPLES
25+
26+
`ffcvt` comes with comprehensive online documents. For further details,
27+
please go to:
28+
29+
https://github.com/suntong/ffcvt#encoding-help
30+
31+
https://github.com/suntong/ffcvt/wiki
32+
33+
34+
## SEE ALSO
35+
36+
`ffmpeg(1)`
37+
38+
39+
## AUTHORS
40+
41+
Tong Sun <suntong@cpan.org>

ffcvt.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const _encodedExt = "_.mkv"
4141

4242
var (
4343
version = "1.3.3"
44-
date = "2019-04-09"
44+
date = "2019-04-19"
4545

4646
sprintf = fmt.Sprintf
4747
encodedExt string = _encodedExt

0 commit comments

Comments
 (0)