← Back to branch summary

~pnutzh4x0r/driveshaft/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Peter Bui
  • Date: 2009-02-18 08:24:08 UTC
  • Revision ID: pbui@phoenix-20090218082408-2f2z10ayxyztf6wz
Begin README

Right now, just use the generated usage output.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
--------------------------------------------------------------------------------
 
2
Driveshaft: README
 
3
--------------------------------------------------------------------------------
 
4
 
 
5
driveshaft 0.1.3
 
6
----------------
 
7
 
 
8
Auto-magical front-end to HandBrake
 
9
 
 
10
Usage: driveshaft [option1=value1 ...]
 
11
 
 
12
  General Options:
 
13
   -a action             Action to perform (Default: help)
 
14
   -k handbrake_binary   Path to HandBrakeCLI executable (Default: /usr/local/bin/HandBrakeCLI)
 
15
   -h help               Output usage and help message (Default: True)
 
16
   -i input_devices      List of input devices to scan (Default: /media/cdrom0, /media/dvd0)
 
17
   -l native_language    Language to use for audio tracks (Default: English)
 
18
   -s subtitle_language  Language to use for subtitle (Default: None)
 
19
   -x time_maximum       Maximum track duration (Default: 300 minutes)
 
20
   -n time_minimum       Minimum track duration (Default: 30 minutes)
 
21
   -v verbose            Output extra information (Default: False)
 
22
 
 
23
  Output Options:
 
24
   -f output_container   Output file container format (Default: mp4)
 
25
   -y output_directory   Output directory (Default: .)
 
26
   -p output_prefix      Output file prefix (Default: Track)
 
27
 
 
28
  Audio Options:
 
29
   -B audio_bitrate      Audio bitrate (Default: 128)
 
30
   -E audio_encoder      Audio encoder (faac, lame, vorbis, ac3) (Default: faac)
 
31
   -R audio_samplerate   Audio samplerate (22.05, 24, 32, 44.1, 48) (Default: 44.1)
 
32
 
 
33
  Video Options:
 
34
   -b video_bitrate      Video bitrate (Default: 1250)
 
35
   -d video_deinterlace  Deinterlace video (Default: False)
 
36
   -e video_encoder      Video encoder (ffmpeg, xvid) (Default: ffmpeg)
 
37
   -2 video_use_twopass  Use twopass encoding (Default: False)
 
38
 
 
39
  Configuration file:
 
40
   Settings can be stored in the configuration file ~/.driveshaftrc
 
41
        
 
42
  Examples:
 
43
   # Scan /media/dvd0 for tracks
 
44
   driveshaft -a scan -i /media/dvd0 
 
45
   driveshaft -a=scan -i=/media/dvd0 
 
46
   driveshaft action=scan input_devices=/media/dvd0 
 
47
 
 
48
   # Verbosely rip tracks with lengths between 10 and 40 minutes
 
49
   driveshaft -a rip -n 10 -x 40 -v 
 
50
   driveshaft -a=rip -n=10 -x=40 -v 
 
51
   driveshaft action=rip time_minimum=10 time_maximum=40 verbose 
 
52
 
 
53
   # Rip with Italian audio tracks and English subtitles
 
54
   driveshaft -a rip -l Italiano -s English 
 
55
   driveshaft -a=rip -l=Italiano -s=English 
 
56
   driveshaft action=rip native_language=Italiano subtitle_language=English 
 
57
 
 
58
   # Example configuration file
 
59
   verbose=1'
 
60
   input_devices=video_ts,VIDEO_TS,/media/cdrom0,/media/dvd0
 
61
   video_deinterlace=1
 
62
   video_use_twopass=1
 
63
        
 
64
  Credits:
 
65
 
 
66
   Peter Bui <pnutzh4x0r@gmail.com>
 
67
   HandBrake (http://handbrake.fr)
 
68
 
 
69
--------------------------------------------------------------------------------