HISAT2-BUILD-S(1)

πŸ’– hisat2-build-s β€” the small-index build bestie πŸ’–

okay so. this is the manual page for hisat2-build-s (that's the HISAT2-BUILD-S(1) page, in User Commands land), and it's basically the small index binary of the HISAT2 indexer. it's giving "tiny but mighty" energy and honestly? we're obsessed. πŸŽ€


✨ SYNOPSIS ✨

hisat2-build [options]* <reference_in> <ht2_index_base>

🌸 DESCRIPTION 🌸

so this whole thing is HISAT2 version 2.2.1, brought to you by Daehwan Kim (infphilo@gmail.com, http://www.ccb.jhu.edu/people/infphilo). king behavior fr fr πŸ‘‘

here's what the two main characters of this command are:

  • reference_in β€” a comma-separated list of files with ref sequences. yes, commas. don't come at me with spaces, bestie. 😭
  • hisat2_index_base β€” where the ht2 data goes, written to files with this dir/basename. that's the whole path-plus-name situation. πŸ¦‹

⭐ OPTIONS ⭐

a whole menu of little switches, and every single one of them matters, so let's go one by one, no skipping, we're being thorough today πŸ’…

  • -c β€” reference sequences are given right there on the cmd line (as <reference_in>). living dangerously, iconic.
  • -a/--noauto β€” turns OFF the automatic -p/--bmax/--dcv memory-fitting. you're on your own now, bestie.
  • -p <int> β€” number of threads. go parallel, go fast, go slay. πŸ”₯
  • --bmax <int> β€” max bucket sz for blockwise suffix-array builder.
  • --bmaxdivn <int> β€” max bucket sz as divisor of ref len (default: 4).
  • --dcv <int> β€” diff-cover period for blockwise (default: 1024).
  • --nodc β€” disables diff-cover. ⚠️ heads up: the algorithm becomes quadratic. that's the bad one. proceed with caution, no cap.
  • -r/--noref β€” don't build the .3/.4.ht2 (packed reference) portion.
  • -3/--justref β€” just build the .3/.4.ht2 (packed reference) portion. the opposite vibe of the one above, cute.
  • -o/--offrate <int> β€” SA is sampled every 2^offRate BWT chars (default: 5).
  • -t/--ftabchars <int> β€” # of chars consumed in initial lookup (default: 10).
  • --localoffrate <int> β€” SA (local) is sampled every 2^offRate BWT chars (default: 3).
  • --localftabchars <int> β€” # of chars consumed in initial lookup in a local index (default: 6).
  • --snp <path> β€” SNP file name.
  • --haplotype <path> β€” haplotype file name.
  • --ss <path> β€” Splice site file name.
  • --exon <path> β€” Exon file name.
  • --repeat-ref <path> β€” Repeat reference file name.
  • --repeat-info <path> β€” Repeat information file name.
  • --repeat-snp <path> β€” Repeat snp file name.
  • --repeat-haplotype <path> β€” Repeat haplotype file name.
  • --seed <int> β€” seed for random number generator. deterministic queen 🌈
  • -q/--quiet β€” disables verbose output (for debugging). shhh. 🀫
  • -h/--help β€” prints a detailed description of the tool and its options.
  • --usage β€” prints this usage message.
  • --version β€” prints version information and quits. the classic mic drop. 🎀

and then there's this little build-info paragraph that lives at the end of the options, and it's honestly its own main character:

64-bit Built on Debian 21 January 2026 Compiler: gcc version 15.2.0 (Ubuntu 15.2.0-11ubuntu1) Options: -O3 -funroll-loops -g3 -Wdate-time -D_FORTIFY_SOURCE=3 -std=c++11 Sizeof {int, long, long long, void*, size_t, off_t}: {4, 8, 8, 8, 8, 8}

lowkey important: that Sizeof list is {4, 8, 8, 8, 8, 8} β€” so int is 4 and everything else in the list is 8. bookmark it. πŸ“

πŸ‘‘ sign-off πŸ‘‘

that's the whole page, bestie!! this was hisat2-build-s version 2.2.1, dated January 2026, and the manual page name is HISAT2-BUILD-S(1) β€” go forth and build those indexes, you absolute legend. no notes. periodt. πŸ’œπŸ§šβœ¨

πŸ“¦ where this page comes from