OF-Scraper
  • Welcome
  • Requirements
  • Install
    • Pre-Install Guides
      • Linux
      • Windows
      • Mac
    • PIPX Install
    • PIP Install
    • Binary Releases
    • Docker
    • Release Info
    • Managing Multiple Python Versions
  • Getting Started and Settings
    • Config Options
      • Config Location
      • General Options
      • File Output Options
        • Placeholders
        • Responsetype Placeholders
      • Download Options
        • Download Toggles
        • Media Filtering Options
        • Advanced Download Options
      • Setting metadata path
      • Binaries Options
      • CDM Options
      • Performance Options
        • Values to Pick
      • Script Options
      • Advanced config options
        • Changing Const Values
        • Mediatype overwrites
    • Depreciated Options
    • Auth
    • Controlling Output/Logs
    • Migrating from Digitalcriminal's script
  • Using the Scraper
    • Using Prompts
      • Old Menu
      • Page 2
    • Username selection or Fuzzy Search
    • Basic Automation with command-line
      • Basic Actions
        • Liking/Unliking Post
        • Downloading Content
          • Downloading Text Files
          • Downloading Purchases From Deleted Models
        • Multiple Actions
      • Model Filtering/Sorting
        • Price Filtering/Sort
      • Advanced Args
      • Scripting tips
      • Enable label scan
    • Recipes
      • Adding Proxy
      • Redownload Deleted Downloads
  • Content Check Modes
    • Table Columns
    • Table Management
      • Pre 3.10.7 filtering
  • Scraping Individual Posts or Media
  • Metadata
    • Schema
    • Creating Metadata
    • Metadata location
  • CDM Setup
    • CDM issues
  • FAQ/Common Issues
    • Page 1
  • Command Reference
    • Shared Options
      • General Program Options
        • Program Options
        • Logging Options
        • Filename Modification Options
        • Media Filters Options
        • Download Options
        • Advanced Program Options
      • Shared Scrape and Metadata Check Mode Options
        • User List Filter Options
          • Advanced User Filters
        • User Selection Options
        • Model Sorting & Processing Options
        • Content Options
        • Automation Options
        • Advanced Search & Processing Options
    • Main Scraper Options
    • Metadata Check Mode Options
    • Content Check Modes Options
    • Manual Mode Options
  • Request Change to Doc
  • Testing
Powered by GitBook
On this page
  • Filename Modification Parameters
  • -g, --original
  • -tt, --text-type [argument]
  • -sr, --space-replacer [argument] (optional)
  • -tl, --textlength [argument]
  1. Command Reference
  2. Shared Options
  3. General Program Options

Filename Modification Options

These options allow you to customize how the program generates filenames for downloaded content

Filename Modification Parameters

-g, --original

  • Disables: Truncation of long file paths.

  • Default: None (paths are truncated by default)

  • Use case: You might want to use this option if you need to preserve the entire original file path for organizational purposes.

-tt, --text-type [argument]

  • Sets: The type of unit used to determine the maximum length of the filename text placeholder

  • Possible choices:

    • word: (default) Splits the filename text placeholder into words and considers word count for truncation.

    • letter: Considers the total number of characters in the filename text placeholder for truncation.

  • Example: With -tt letter and -tl 10, text placeholder would be truncated to a maximum of 10 characters

-sr, --space-replacer [argument] (optional)

  • Replaces: Spaces in the filename text with the specified character.

  • Default: None (spaces are left as spaces)

  • Use case: This can be helpful for creating filenames compatible with certain file systems or applications that disallow spaces.

  • Example: With -sr _, spaces would be replaced with underscores (e.g., "This File.txt" becomes "This_File.txt").

-tl, --textlength [argument]

  • Sets: The maximum length of the filename text placeholder

  • Default: None (no limit on text length)

  • Effect: Truncates text placeholders that exceed the specified length.

  • Use case: This is useful for ensuring filenames adhere to character limitations imposed by some file systems, as text placeholders can easily go over OS limits

Note:

  • These options work together to modify the final filename.

  • If truncation occurs, it will be based on the chosen -tt type (word or letter) ,the provided -tl length, and the current OS

PreviousLogging OptionsNextMedia Filters Options

Last updated 1 year ago