Skip to content

Commit

Permalink
- [*] update doc and add manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
suntong committed Apr 19, 2019
1 parent d84eab9 commit ea2300a
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.e.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ Please check them out in the [wiki](https://github.com/suntong/ffcvt/wiki/).

## Download/Install

### Using `apt`

The `ffcvt` is now officially in Debian repository, so the installation is now as simple as a `apt install`/`apt-get install`:

apt install ffcvt

### Download binaries

- The latest binary executables are available under
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Environment Variables](#environment-variables)
- [Encoding Help](#encoding-help)
- [Download/Install](#downloadinstall)
- [Using `apt`](#using-`apt`)
- [Download binaries](#download-binaries)
- [Debian package](#debian-package)
- [Install Source](#install-source)
Expand Down Expand Up @@ -75,6 +76,7 @@ Flags:
-force overwrite any existing none-empty file (FFCVT_FORCE)
-debug debugging level (FFCVT_DEBUG)
-ffmpeg ffmpeg program executable name (FFCVT_FFMPEG)
-version print version then exit (FFCVT_VERSION)

Details:

Expand Down Expand Up @@ -123,6 +125,8 @@ Details:
copy video codec
-vea string
video encoding method append
-version
print version then exit
-ves string
video encoding method set
-vn
Expand Down Expand Up @@ -156,6 +160,12 @@ Please check them out in the [wiki](https://github.com/suntong/ffcvt/wiki/).

## Download/Install

### Using `apt`

The `ffcvt` is now officially in Debian repository, so the installation is now as simple as a `apt install`/`apt-get install`:

apt install ffcvt

### Download binaries

- The latest binary executables are available under
Expand Down
41 changes: 41 additions & 0 deletions ffcvt.1.ronn
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# ffcvt -- ffmpeg convert wrapper tool

## SYNOPSIS

ffcvt [flags] [video_filename]


## OPTIONS

For `flags`, run `ffcvt` without parameters to see the comprehensive list and explanation.


## DESCRIPTION

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.

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.

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.

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.


## EXAMPLES

`ffcvt` comes with comprehensive online documents. For further details,
please go to:

https://github.com/suntong/ffcvt#encoding-help

https://github.com/suntong/ffcvt/wiki


## SEE ALSO

`ffmpeg(1)`


## AUTHORS

Tong Sun <suntong@cpan.org>
2 changes: 1 addition & 1 deletion ffcvt.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const _encodedExt = "_.mkv"

var (
version = "1.3.3"
date = "2019-04-09"
date = "2019-04-19"

sprintf = fmt.Sprintf
encodedExt string = _encodedExt
Expand Down

0 comments on commit ea2300a

Please sign in to comment.