Nzbirc/guide/using

From tiberious.org

Main_Page > Nzbirc > Guide > 5. Using

Previous section: 4. Running

Contents 1 Guide Contents 2 Using NZBirc 2.1 Newzbin Module 2.1.1 Searching for NZB files 2.1.2 Downloading NZB files 2.1.2.1 ID 2.1.2.2 Name 2.1.2.3 Flags 2.1.2.4 Variables 2.1.3 History 2.2 HellaNZB Module 2.2.1 Status 2.2.2 Pause/Unpause 2.2.3 Rate Limiting 2.2.3.1 Rate Scheduling 2.3 AutoTV Module 2.3.1 Adding a show 2.3.2 Listing shows 2.3.2.1 Name 2.3.2.2 Date 2.3.3 Editing shows 2.3.3.1 Alternatives 2.3.3.2 tvrageIDonly 2.3.3.3 flags 2.4 AutoQuery Module 2.4.1 Adding a query 2.4.2 Listing shows 2.4.2.1 Name

Guide Contents

1. Downloading
2. Installation
3. Configuration
4. Running
5. Using

Using NZBirc

There are a few basic commands that are the most commonly used, for a complete list of commands see Nzbirc/v1#Commands

All commands are based on the default triggers (which can be changed in the config file)

Newzbin Module

The commands listed here are almost exactly the same as the commands required for tvnzb.com nzb downloading (tvnzb works of names, rather than id's)

• NZB help entry

Searching for NZB files

• NZB search help entry

A useful feature is the ability to search newzbin.com, currently you can not specify what category to search, but you can specify flags, which will be mentioned later.

To do a search the following command can be used

!nzb search Boston Legal 5x10

which returns the results:

(3276844) TV: Boston Legal - 5x10 - Thanksgiving | Source:TV Cap, HDTV, Video Fmt:x264, 720p, Language:English [25th Nov (2d ago), 1.19 gb] file: boston.legal.510.720p-dimension.nfo
(3276808) TV: Boston Legal - 5x10 - Thanksgiving | Source:TV Cap, Video Fmt:XviD, Language:English [25th Nov (2d ago), 400.6 mb] file: boston.legal.510.hdtv-lol.nfo

By default this is limited to 4 results maximum, (this can be changed in the config file)

The results are in the format:

({nzbid}) {category}: {title} | {attributes} [{reported date}, {size}] file: {filename}

The attributes specify information about the post that is contained on newzbin.com, more information can be found in flags.

If you want to limit the results you can add the flag options to the search command like so:

!nzb search Boston Legal 5x10 f:x264

this will return the only matching entries

(3276844) TV: Boston Legal - 5x10 - Thanksgiving | Source:TV Cap, HDTV, Video Fmt:x264, 720p, Language:English [25th Nov (2d ago), 1.19 gb] file: boston.legal.510.720p-dimension.nfo

Multiple flags can be used to rank the results based on their aptitude, for example searching for

!nzb search Boston Legal 5x10 f:720p&x264,xvid

will return all the results listed above, but will place the 720p and x264 result first, and the xvid results last. Results with the same flags will be ordered in age, with the newest first. This also shows some simple logic that is available, where both the 720p and x264 flags are required

Downloading NZB files

• NZB add help entry

ID

The easiest way is to just use the newzbin id with the following command.

!nzb add 2460957

The bot will then respond eventually with

Queued: [2460957:Boston Legal - 3x22 - Guantanamo By The Bay]

The nzb file for 2460957 has been placed in the folder specified in the config file (if using nzbirc to download the file)

Name

Alternatively you can use the name of the post to get the nzb, ie:

!nzb add Boston Legal 3x22

which will also return

Queued: [2460957:Boston Legal - 3x22 - Guantanamo By The Bay]

This will download the first result it finds that matches the string given.

Flags

Here you can also use the flags, mentioned in the search section above to restrict the results you wish to download. So to download boston legal 3x22, in the xvid format, the following can be used.

!nzb add Boston Legal 3x22 f:xvid

which will return

Queued: [2460798:Boston Legal - 3x22 - Guantanamo By The Bay]

Variables

Variables can also be used to download a range of entries.

For example, if you wanted to download all the episodes of Boston Legal, season 3, the following command can be used.

!nzb add Boston Legal 3x{01-22}

The numbers inside the curly brackets { } signify a range or collection of values. A few more examples: {01,02,03}, {cat,dog,mouse}, {01,03-05,09}

Note that the first entry is 01 rather than 1. Adding the 0 makes it search for 01,02,03 etc rather than 1,2,3.

Multiple variables can be used in a single string (there is no limit to the number that can be used). Say for example you wanted to download an entire TV series you can use this.

!nzb add Boston Legal {1-3}x{01-24}

This will download all the episodes (01-24) from series (1-3).

These variables also work with flags, if you want to make sure you get the best quality results.

History

NZBirc has a record of the nzb's queued through it and, they can be displayed using the history command, the command takes a common date format and displays the entries on the matching days.

!nzb history today

[Today] (03:04am) 2460549: NCIS - 4x23 - Trojan Horse, (07:12am) 2460753: House - 3x22 - Resignation, (09:32am) 2460797: Boston Legal - 3x22 - Guantanamo By The Bay, (11:32am) 2460957: Boston Legal - 3x22 - Guantanamo By The Bay, (01:05pm) 2460994: NCIS - 4x23 - Trojan Horse

HellaNZB Module

• Hella help entry

Note: the command !nzb is used here, for compatibility with v0 of nzbirc, but it can be easily changed to !hella or something else (in the config file)

Status

• Hella status help entry

The most commonly used command is the status command. This tells you what hellanzb is currently doing

!nzb status

returns

Hellanzb 0.13: up 29 days, 14:10 | downloaded 20 nzbs, 942 files (12.8 gb) - 645.7/350 kb/s [487.0 mb, ETA: 12m 53s (40%)]
Downloading: [379:2460994] (tiberious) NCIS - 4x23 - Trojan Horse, Processing: None, Queued: 0 (0.00 mb, 0)

This command also tells you how big the queue is, and how long it will take to download it.

Pause/Unpause

• Hella pause help entry
• Hella unpause help entry

If you want to do something else with the connection, and you need to pause hellanzb it can be done like this:

!nzb pause

this will return

Download paused for 1h

This means that in 1 hour it will automatically unpause. This time can be adjusted by adding a duration to the end of the pause command like so:

!nzb pause 4h

returns

Download paused for 4h

Unpausing resumes the downloads:

!nzb unpause

Downloads have been resumed

Rate Limiting

• Hella maxrate help entry

To simply alter the rate of hellanzb the following command can be used

!nzb rate 350

which returns

Maxrate set to: 350 kb/s

the number is always in kb/s. 0 signifies unlimited speed

Rate Scheduling

Nzbirc also allows you to schedule rate changes. This will automatically change the rate based on the time of the day.

Adding an entry for scheduling is done like so:

!nzb rate add 0 2:00am 

This will add an entry at 2am every day to change the rate to unlimited.

Added a rate schedule entry at: 02:00am setting rate: 0 kb/s

Adding a few more:

!nzb rate add 200 9:00am
!nzb rate add 300 7:00pm

These can then be listed, to see what entries you have:

!nzb rate list

returns

Current schedule rate changes: 02:00am: Unlimited kb/s, 09:00am: 200 kb/s, 07:00pm: 300 kb/s

Deleting an entry can be done by:

!nzb rate del 02:00am

Deleted the rate schedule entry at: 02:00am

AutoTV Module

This module allows you to automatically download the latest tv episodes when they are posted to usenet.

• AutoTV help entry

Adding a show

Adding a show to be searched can be done with:

!autotv add the unit

this will return something like

Added The Unit to the autodownloader, upcoming episodes: 2x23 - Paradise Lost [Yesterday]

Flags can be specified when adding a show by appending something like f:720p,xvid with the flags you want after the show name. The config file contains the default flags, which are used when they are not specified.

Listing shows

You can see what shows you have using the list command

!autotv list

This will list all the shows you have added to the autotv downloader. If the number of shows exceedes a listLimit (default 6), the shows will be shown on a single line (the listLimit can be set in the config)

Name

You can specify the show name here you wish to get information about

!autotv list Unit

returns

The Unit: f:720p, xvid | 2x23 [Yesterday]

The f: signify the flags the show will be downloaded in.

The 2x23 [Yesterday] part lists its episodes (with a 2 week history of previously downloaded shows)

For shows which have not yet aired, the date is underlined (not shown here), for quicker identification

An example of a show which has been downloaded:

!autotv list boston legal

Boston Legal: f:hr, xvid | p:none | 3x21 [1st May (1w 1d ago) | hr:2449876, xvid:2449827], 3x22 [Yesterday | hr:2460957, xvid:2460797], 3x23 [15th May (6d)]

Here the air date of the episodes, and the nzbid's that were downloaded are listed.

Tip: If you wish to view the episode name, you can alter the episodeList template entry in the autotv.php module file to:

'{series}x{episode} - {title} [{airdate}{flagQueueBridge}]'

Date

You can also list shows depending on when they air, using common date formats

for example

!autotv list yesterday

House: f:720p, hr | 3x21 [1st May (1w 1d ago) | 720p:2450079, hr:2449875], 3x22 [Yesterday | 720p:2460753], 3x23 [15th May (6d)]
Boston Legal: f:hr, xvid | 3x21 [1st May (1w 1d ago) | hr:2449876, xvid:2449827], 3x22 [Yesterday | hr:2460957, xvid:2460797], 3x23 [15th May (6d)]
The Unit: f:hr, xvid | 2x23 [Yesterday]

You can even combine name search and date search with

!autotv list the yesterday

The Unit: f:hr, xvid | 2x23 [Yesterday]

Editing shows

It is possible to edit information about the shows, and some of the more useful commands with be shown.

Available variables: name, alias, alternatives, tvrageID, tvrageIDonly, priority, checkTime, hourlyCheckLength, dailyCheckLength, flags, airtime, airday, airReminder

A brief overview can be found here

These options can change when a show is checked for, how long it is checked for hourly, and daily, what versions are downloaded, and many more.

Note: airtime, airday and airReminder are currently not implemented completely.

Alternatives

Sometimes shows are listed on newzbin, differently to tvrage. using the alternatives you can add alternative names for the show, for when it searches newzbin to find the show.

!autotv edit Battlestar Galactica alternatives +Battlestar Galactica (2003)

The + option signifies that you are adding an entry to an array (you can have as many alternatives for a show as you wish.

tvrageIDonly

This option allows you to search for episodes based on their url (in particular their tvrage ShowID and episodeID). This allows you to download the correct files if tvrage and newzbin show different number systems for show, ie: Shows with dates in (Jay Leno, etc), shows with different numbering (Family Guy, American Dad, etc).

!autotv edit Family Guy tvrageIDonly = true

flags

This option sets the flags for the show to download, if you set the wrong flags when adding the show, or want to change them you can by using this.

The flags is an array, but can be set using the = command, with different entries seperated by a comma (,). This is because the entries are required to be in a particular order.

!autotv edit house flags = 720p,hr,xvid

AutoQuery Module

This module allows you to automatically download the latest tv episodes when they are posted to usenet.

• AutoQuery help entry

Adding a query

Adding a query to be searched can be done with:

!autoquery add "the dark knight"

this will return something like

Added "the dark knight" to the autodownloader

Flags can be specified when adding a show by appending something like f:720p,xvid with the flags you want after the show name. The config file contains the default flags, which are used when they are not specified.

Listing shows

You can see what shows you have using the list command

!autoquery list

This will list all the shows you have added to the autoquery downloader. If the number of queries excedes a listLimit (default 6), the shows will be shown on a single line (the listLimit can be set in the config)

Name

You can specify the query name here you wish to get information about

!autoquery list dark

returns

"the dark knight": f:1080p, 720p | chk:5h 49m ago

Back to Guide: Nzbirc/guide